logo
On this page

ZegoVideoConfig

ZegoVideoConfig

Video config.

Details

Configure parameters used for publishing stream, such as bitrate, frame rate, and resolution. Developers should note that the width and height resolution of the mobile and desktop are opposite. For example, 360p, the resolution of the mobile is 360x640, and the desktop is 640x360. When using external capture, the capture and encoding resolution of RTC cannot be set to 0*0, otherwise, there will be no video data in the publishing stream in the entire engine life cycle.

Declared in ZegoExpressDefines.h

Properties

captureResolution

captureResolution
nonatomic, assign CGSize captureResolution

Capture resolution, control the resolution of camera image acquisition. SDK requires the width and height to be set to even numbers. Only the camera is not started and the custom video capture is not used, the setting is effective. For performance reasons, the SDK scales the video frame to the encoding resolution after capturing from camera and before rendering to the preview view. Therefore, the resolution of the preview image is the encoding resolution. If you need the resolution of the preview image to be this value, Please call [setCapturePipelineScaleMode] first to change the capture pipeline scale mode to [Post]

encodeResolution

encodeResolution
nonatomic, assign CGSize encodeResolution

Encode resolution, control the image resolution of the encoder when publishing stream. SDK requires the width and height to be set to even numbers. The settings before and after publishing stream can be effective

fps

fps
nonatomic, assign int fps

Frame rate, control the frame rate of the camera and the frame rate of the encoder. Publishing stream set to 60 fps, playing stream to take effect need contact technical support

bitrate

bitrate
nonatomic, assign int bitrate

Bit rate in kbps. The settings before and after publishing stream can be effective. The SDK will automatically set the bit rate suitable for the scenario selected by the developer. If the bit rate manually set by the developer exceeds the reasonable range, the SDK will automatically process the bit rate according to the reasonable range. If you need to configure a high bit rate due to business needs, please contact ZEGO Business.

codecID

codecID
nonatomic, assign ZegoVideoCodecID codecID

The codec id to be used, the default value is [default]. Settings only take effect before publishing stream

keyFrameInterval

keyFrameInterval
nonatomic, assign int keyFrameInterval
  • Required: No.
  • Default value: 2 seconds.
  • Value range: [2, 5].
  • Caution: The setting is only valid before pushing.

Methods

defaultConfig

defaultConfig
- (void)+ (instancetype)defaultConfig;
Create default video configuration(360p, 15fps, 600kbps)
Declared in ZegoExpressDefines.h

360p, 15fps, 600kbps

ZegoVideoConfig instance

configWithPreset

configWithPreset
- (void)+ (instancetype)configWithPreset:(ZegoVideoConfigPreset)preset;
Create video configuration with preset enumeration values
Declared in ZegoExpressDefines.h

ZegoVideoConfig instance

initWithPreset

initWithPreset
- (instancetype)initWithPreset:(ZegoVideoConfigPreset)preset;
Create video configuration with preset enumeration values
Declared in ZegoExpressDefines.h

ZegoVideoConfig instance

Previous

zegouser

Next

zegovideodenoiseparams

On this page

Back to top