ChannelMediaOptions class

频道媒体设置选项。

RtcConnection publishMicrophoneTrack publishCustomAudioTrack publishMediaPlayerAudioTrack true publishCameraTrack publishScreenCaptureVideo 、 publishScreenTrack 、 publishCustomVideoTrack publishEncodedVideoTrack true 建议你根据业务场景自行设置成员参数值，否则 SDK 会自动对成员参数进行赋值。

Annotations

• @JsonSerializable.new(explicitToJson: true, includeIfNull: false)

Properties

audienceLatencyLevel → AudienceLatencyLevelType?

观众端延时级别。详见 AudienceLatencyLevelType 。

final

audioDelayMs → int?

发送音频帧的延时（毫秒）。你可以通过该参数来设置需要发送的音频帧的延时，以确保音画同步。 如果要关闭延时，将此参数值设置为 0。

final

autoSubscribeAudio → bool?

设置是否自动订阅所有音频流： true ：自动订阅所有音频流。 false ：不自动订阅任何音频流。

final

autoSubscribeVideo → bool?

设置是否自动订阅所有视频流： true ：自动订阅所有视频流。 false ：不自动订阅任何视频流。

final

channelProfile → ChannelProfileType?

频道使用场景。详见 ChannelProfileType 。

final

clientRoleType → ClientRoleType?

用户角色。详见 ClientRoleType 。

final

customVideoTrackId → int?

调用 createCustomVideoTrack 方法返回的视频轨道 ID。默认值为 0。

final

defaultVideoStreamType → VideoStreamType?

默认订阅的视频流类型: VideoStreamType 。

final

downlinkMultipathMode → MultipathMode?

下行传输模式。详见 MultipathMode 。 使用该参数时，请确保已将 enableMultipath 设置为 true 。

final

enableAudioRecordingOrPlayout → bool?

如果那你需要发布麦克风采集的音频流，请确保该参数设为 true 。 设置是否开启音频录制或播放： true ：开启音频录制或播放。 false ：不开启音频录制或播放。

final

enableMultipath → bool?

权限和系统要求： Android：Android 7.0 或更高版本（API 级别 24 或更高），需要 ACCESS_NETWORK_STATE 和 CHANGE_NETWORK_STATE 权限。 iOS：iOS 12.0 或更高版本。 macOS：10.14 或更高版本。 Windows：Windows Vista 或更高版本。 是否启用多路径传输： true ：启用多路径传输。 false ：禁用多路径传输。

final

hashCode → int

The hash code for this object.

no setter, inherited

isAudioFilterable → bool?

如需启用该功能，请联系销售。 设置是否让当前音频流根据音强算法参与选流。 true ：参与音强选流。如未开启音强选流功能，该参数不会生效。 false ：不参与音强选流。

final

isInteractiveAudience → bool?

该参数用于实现跨直播间连麦场景。连麦主播需要调用 joinChannelEx 方法，以观众身份加入对方的直播间，并将 isInteractiveAudience 设置为 true 。 仅当用户角色为 clientRoleAudience 时，该参数生效。 是否开启互动观众模式： true ：开启互动观众模式。成功开启后，本地用户作为互动观众，收到低延时和流畅的远端用户视频。 false ：不开启互动观众模式。本地用户作为普通观众，收到默认设置的远端用户视频。

final

preferMultipathType → MultipathType?

首选的传输路径类型。详见 MultipathType 。 使用该参数时，请确保已将 enableMultipath 设置为 true 。

final

publishCameraTrack → bool?

设置是否发布摄像头采集的视频： true ：发布摄像头采集的视频。 false ：不发布摄像头采集的视频。

final

publishCustomAudioTrack → bool?

设置是否发布自定义采集的音频： true ：发布自定义采集到的音频。 false ：不发布自定义采集到的音频。

final

publishCustomAudioTrackId → int?

待发布的自定义音频轨道的 ID，默认值为 0。你可以通过 createCustomAudioTrack 方法来获取自定义音频轨道 ID。

final

publishCustomVideoTrack → bool?

设置是否发布自定义采集的视频： true ：发布自定义采集的视频。 false ：不发布自定义采集到的视频。

final

publishEncodedVideoTrack → bool?

设置是否发布编码后的视频： true ：发布编码后的视频 。 false ：不发布编码后的视频。

final

publishFourthCameraTrack → bool?

该参数仅适用于 Android、Windows 和 macOS 平台。 设置是否发布第四个摄像头采集的视频： true ：发布第四个摄像头采集的视频。 false ：不发布第四个摄像头采集的视频。

final

publishFourthScreenTrack → bool?

该参数仅适用于 Windows 和 macOS 平台。 设置是否发布第四个屏幕采集的视频： true ：发布第四个屏幕采集到的视频。 false ：不发布第四个屏幕采集到的视频。

final

publishLipSyncTrack → bool?

设置是否发布语音驱动插件处理后的视频： true ：发布语音驱动插件处理后的视频。 false ：（默认）不发布语音驱动插件处理后的视频。

final

publishMediaPlayerAudioTrack → bool?

设置是否发布媒体播放器的音频： true ：发布媒体播放器的音频。 false ：不发布媒体播放器的音频。

final

publishMediaPlayerId → int?

待发布的媒体播放器的 ID。默认值为 0。

final

publishMediaPlayerVideoTrack → bool?

设置是否发布媒体播放器的视频： true ：发布媒体播放器的视频。 false ：不发布媒体播放器的视频。

final

publishMicrophoneTrack → bool?

设置是否发布麦克风采集到的音频： true ：发布麦克风采集到的音频。 false ：不发布麦克风采集到的音频。

final

publishMixedAudioTrack → bool?

设置是否发布本地混音音频： true ：发布本地混音音频。 false ：不发布本地混音音频。

final

publishRhythmPlayerTrack → bool?

设置是否发布虚拟节拍器声音至远端： true ：发布。本地用户和远端用户都能听到节拍器。 false ：不发布。只有本地用户能听到节拍器。

final

publishScreenCaptureAudio → bool?

该参数仅适用于 Android 和 iOS 平台。 设置是否发布屏幕采集的音频： true ：发布屏幕采集到的音频。 false ：不发布屏幕采集到的音频。

final

publishScreenCaptureVideo → bool?

该参数仅适用于 Android 和 iOS 平台。 设置是否发布屏幕采集的视频： true ：发布屏幕采集到的视频。 false ：不发布屏幕采集到的视频。

final

publishScreenTrack → bool?

该参数仅适用于 Windows 和 macOS 平台。 设置是否发布屏幕采集的视频： true ：发布屏幕采集到的视频。 false ：不发布屏幕采集到的视频。

final

publishSecondaryCameraTrack → bool?

设置是否发布第二个摄像头采集的视频： true ：发布第二个摄像头采集的视频。 false ：不发布第二个摄像头采集的视频。

final

publishSecondaryScreenTrack → bool?

设置是否发布第二个屏幕采集的视频： true ：发布第二个屏幕采集到的视频。 false ：不发布第二个屏幕采集到的视频。

final

publishThirdCameraTrack → bool?

该参数仅适用于 Android、Windows 和 macOS 平台。 设置是否发布第三个摄像头采集的视频： true ：发布第三个摄像头采集的视频。 false ：不发布第三个摄像头采集的视频。

final

publishThirdScreenTrack → bool?

该参数仅适用于 Windows 和 macOS 平台。 设置是否发布第三个屏幕采集的视频： true ：发布第三个屏幕采集到的视频。 false ：不发布第三个屏幕采集到的视频。

final

publishTranscodedVideoTrack → bool?

设置是否发布本地的转码视频： true ：发布本地的转码视频。 false ：不发布本地的转码视频。

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

token → String?

（可选）在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。 该参数仅在调用 updateChannelMediaOptions 或 updateChannelMediaOptionsEx 时生效。 请确保用于生成 token 的 App ID、频道名和用户名和 initialize 方法初始化引擎时用的 App ID，以及 joinChannel 或 joinChannelEx 方法加入频道时设置的频道名和用户名是一致的。

final

uplinkMultipathMode → MultipathMode?

上行传输模式。详见 MultipathMode 。 使用该参数时，请确保已将 enableMultipath 设置为 true 。

final

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited