Options
All
  • Public
  • Public/Protected
  • All
Menu

Advanced player configuration.

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

Hierarchy

  • ZegoPlayerConfig

Index

Constructors

constructor

Properties

Optional adaptiveSwitch

adaptiveSwitch: undefined | number

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.

Optional adaptiveTemplateIDList

adaptiveTemplateIDList: number[]

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

Optional cdnConfig

cdnConfig: ZegoCDNConfig

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.

Optional codecTemplateID

codecTemplateID: undefined | number

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

Optional customResourceConfig

customResourceConfig: ZegoCustomPlayerResourceConfig

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

Optional resourceMode

Stream resource mode.

Optional resourceSwitchMode

resourceSwitchMode: ZegoStreamResourceSwitchMode

Play resource switching strategy mode, the default is ZegoStreamResourceSwitchModeDefault

Optional resourceWhenStopPublish

resourceWhenStopPublish: ZegoStreamResourceType

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.

Optional roomID

roomID: undefined | string

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.

Optional sourceResourceType

sourceResourceType: ZegoResourceType

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

Optional switchStreamConfig

switchStreamConfig: ZegoSwitchPlayingStreamConfig

Extended parameters for the [switchPlayingStream] interface.

Optional videoCodecID

videoCodecID: ZegoVideoCodecID

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

Generated using TypeDoc