logo
On this page

ZegoPlayerConfig

ZegoPlayerConfig

Advanced player configuration.

Details

Configure stream resource mode, CDN configuration and other advanced configurations.

Declared in ZegoExpressDefines.h

Properties

resourceMode

resourceMode
nonatomic, assign ZegoStreamResourceMode resourceMode

Stream resource mode.

cdnConfig

cdnConfig
nonatomic, strong, nullable ZegoCDNConfig * cdnConfig

The CDN configuration for playing stream. If set, the stream is play according to the URL instead of the streamID. After that, the streamID is only used as the ID of SDK internal callback.

roomID

roomID
nonatomic, copy NSString * roomID

The Room ID. It only needs to be filled in the multi-room mode, which indicates which room this stream needs to be bound to. This parameter is ignored in single room mode.

videoCodecID

videoCodecID
nonatomic, assign ZegoVideoCodecID videoCodecID

The video encoding type of the stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

sourceResourceType

sourceResourceType
nonatomic, assign ZegoResourceType sourceResourceType

The resource type of the source stream, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

codecTemplateID

codecTemplateID
nonatomic, assign int codecTemplateID

Preconfigured codec template ID, please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

resourceSwitchMode

resourceSwitchMode
nonatomic, assign ZegoStreamResourceSwitchMode resourceSwitchMode

Play resource switching strategy mode, the default is ZegoStreamResourceSwitchModeDefault

resourceWhenStopPublish

resourceWhenStopPublish
nonatomic, assign ZegoStreamResourceType resourceWhenStopPublish

Play resource type when stop publish, the default is ZegoStreamResourceTypeDefault. This setting takes effect only if the user sets [resourceMode] to ZegoStreamResourceModeDefaut and [resourceSwitchMode] to ZegoStreamResourceSwitchModeDefault or ZegoStreamResourceSwitchModeSwitchToRTC.

adaptiveSwitch

adaptiveSwitch
nonatomic, assign int adaptiveSwitch

Whether to enable adaptive switching of streams, 1 means on, 0 means off. Valid only if [resourceMode] is ZegoStreamResourceModeOnlyL3. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

adaptiveTemplateIDList

adaptiveTemplateIDList
nonatomic, copy NSArray<NSNumber *> * adaptiveTemplateIDList

Stream adaptive transcoding template ID list. Please contact ZEGO technical support if you need to use it, otherwise this parameter can be ignored.

customResourceConfig

customResourceConfig
nonatomic, strong, nullable ZegoCustomPlayerResourceConfig * customResourceConfig

Play stream resource type configuration when [resourceMode] is ZegoStreamResourceModeCustom.

switchStreamConfig

switchStreamConfig
nonatomic, strong, nullable ZegoSwitchPlayingStreamConfig * switchStreamConfig

Extended parameters for the [switchPlayingStream] interface.

Previous

zegopicturecapturer

Next

zegoplaystreamquality

On this page

Back to top