ChannelMediaOptions

频道媒体设置选项。

C++

struct ChannelMediaOptions {
  Optional<bool> publishCameraTrack;
  Optional<bool> publishSecondaryCameraTrack;
  Optional<bool> publishThirdCameraTrack;
  Optional<bool> publishFourthCameraTrack;
  Optional<bool> publishMicrophoneTrack;
  #if defined(__ANDROID__) || (defined(TARGET_OS_IPHONE) && TARGET_OS_IPHONE)
  Optional<bool> publishScreenCaptureVideo;
  Optional<bool> publishScreenCaptureAudio;
  #else
  Optional<bool> publishScreenTrack;
  Optional<bool> publishSecondaryScreenTrack;
  Optional<bool> publishThirdScreenTrack;
  Optional<bool> publishFourthScreenTrack;
  #endif
  Optional<bool> publishCustomAudioTrack;
  Optional<int> publishCustomAudioTrackId;
  Optional<bool> publishCustomVideoTrack;
  Optional<bool> publishEncodedVideoTrack;
  Optional<bool> publishMediaPlayerAudioTrack;
  Optional<bool> publishMediaPlayerVideoTrack;
  Optional<bool> publishTranscodedVideoTrack;
  Optional<bool> autoSubscribeAudio;
  Optional<bool> autoSubscribeVideo;
  Optional<bool> enableAudioRecordingOrPlayout;
  Optional<int> publishMediaPlayerId;
  Optional<CLIENT_ROLE_TYPE> clientRoleType;
  Optional<AUDIENCE_LATENCY_LEVEL_TYPE> audienceLatencyLevel;
  Optional<VIDEO_STREAM_TYPE> defaultVideoStreamType;
  Optional<CHANNEL_PROFILE_TYPE> channelProfile;
  Optional<const char*> token;
  Optional<bool> enableBuiltInMediaEncryption;
  Optional<bool> publishRhythmPlayerTrack;
  Optional<bool> isInteractiveAudience;
  Optional<video_track_id_t> customVideoTrackId;
  Optional<bool> isAudioFilterable;
  ChannelMediaOptions() {}
  ~ChannelMediaOptions() {}

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

publishCameraTrack

设置是否发布摄像头采集的视频：

• true：发布摄像头采集的视频。
  
• false：不发布摄像头采集的视频。
  

publishSecondaryCameraTrack

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

• true：发布第二个摄像头采集的视频。
  
• false：不发布第二个摄像头采集的视频。
  

publishMicrophoneTrack

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

• true：发布麦克风采集到的音频。
  
• false：不发布麦克风采集到的音频。
  

publishThirdCameraTrack

设置是否发布第三个摄像头采集的视频：

• true：发布第三个摄像头采集的视频。
  
• false：不发布第三个摄像头采集的视频。
  

注意： 该参数仅适用于 Windows 和 macOS 平台。

publishFourthCameraTrack

设置是否发布第四个摄像头采集的视频：

• true：发布第四个摄像头采集的视频。
  
• false：不发布第四个摄像头采集的视频。
  

注意： 该参数仅适用于 Windows 和 macOS 平台。

publishScreenTrack

设置是否发布屏幕采集的视频：

• true：发布屏幕采集到的视频。
  
• false：不发布屏幕采集到的视频。
  

注意： 该参数仅适用于 Windows 和 macOS 平台。

publishScreenCaptureVideo

设置是否发布屏幕采集的视频：

• true：发布屏幕采集到的视频。
  
• false：不发布屏幕采集到的视频。
  

注意： 该参数仅适用于 Android 和 iOS 平台。

publishScreenCaptureAudio

设置是否发布屏幕采集的音频：

• true：发布屏幕采集到的音频。
  
• false：不发布屏幕采集到的音频。
  

注意： 该参数仅适用于 Android 和 iOS 平台。

publishSecondaryScreenTrack

设置是否发布第二个屏幕采集的视频：

• true：发布第二个屏幕采集到的视频。
  
• false：不发布第二个屏幕采集到的视频。
  

publishThirdScreenTrack

设置是否发布第三个屏幕采集的视频：

• true：发布第三个屏幕采集到的视频。
  
• false：不发布第三个屏幕采集到的视频。
  

注意： 该参数仅适用于 Windows 和 macOS 平台。

publishFourthScreenTrack

设置是否发布第四个屏幕采集的视频：

• true：发布第四个屏幕采集到的视频。
  
• false：不发布第四个屏幕采集到的视频。
  

注意： 该参数仅适用于 Windows 和 macOS 平台。

publishTranscodedVideoTrack

设置是否发布本地的转码视频：

• true：发布本地的转码视频。
  
• false：不发布本地的转码视频。
  

注： 自 v4.2.0 起，该参数名称由 publishTrancodedVideoTrack 更正为 publishTranscodedVideoTrack。

publishCustomAudioTrack

设置是否发布自定义采集的音频：

• true：发布自定义采集到的音频。
  
• false：不发布自定义采集到的音频。
  

publishCustomAudioTrackId

待发布的自定义音频轨道的 ID。默认值为 0。

如果你已在 setExternalAudioSource 中设置了 sourceNumber 大于 1，SDK 会创建对应数量的自采集音频轨道，并从 0 开始为每一个音频轨道分配一个 ID。

publishCustomVideoTrack

设置是否发布自定义采集的视频：

• true：发布自定义采集的视频。
  
• false：不发布自定义采集到的视频。
  

publishEncodedVideoTrack

设置是否发布编码后的视频：

• true：发布编码后的视频 。
  
• false：不发布编码后的视频。
  

publishMediaPlayerAudioTrack

设置是否发布媒体播放器的音频：

• true：发布媒体播放器的音频。
  
• false：不发布媒体播放器的音频。
  

publishMediaPlayerVideoTrack

设置是否发布媒体播放器的视频：

• true：发布媒体播放器的视频。
  
• false：不发布媒体播放器的视频。
  

autoSubscribeAudio

设置是否自动订阅所有音频流：

• true：自动订阅所有音频流。
  
• false：不自动订阅任何音频流。
  

autoSubscribeVideo

设置是否自动订阅所有视频流：

• true：自动订阅所有视频流。
  
• false：不自动订阅任何视频流。
  

enableAudioRecordingOrPlayout

设置是否开启音频录制或播放：

• true：开启音频录制或播放。
  
• false：不开启音频录制或播放。
  

注： 如果那你需要发布麦克风采集的音频流，请确保该参数设为 true。

publishMediaPlayerId

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

clientRoleType

用户角色。详见 CLIENT_ROLE_TYPE。
注： 角色为观众的用户无法在频道内发布音视频流。在直播场景下发流时，请确保你的用户角色已切换为主播。

audienceLatencyLevel

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

defaultVideoStreamType

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

channelProfile

频道使用场景。详见 CHANNEL_PROFILE_TYPE。

token

（可选）在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。
警告：

• 该参数仅在调用 updateChannelMediaOptions 或 updateChannelMediaOptionsEx 时生效。
  
• 请确保用于生成 token 的 App ID、频道名和用户名和 initialize 方法初始化引擎时用的 App ID，以及 joinChannel [2/2] 或 joinChannelEx 方法加入频道时设置的频道名和用户名是一致的。
  

publishRhythmPlayerTrack

设置是否发布虚拟节拍器声音至远端：

• true：发布。本地用户和远端用户都能听到节拍器。
  
• false：不发布。只有本地用户能听到节拍器。
  

isInteractiveAudience

是否开启互动观众模式：

• true：开启互动观众模式。成功开启后，本地用户作为互动观众，收到低延时和流畅的远端用户视频。
  
• false：不开启互动观众模式。本地用户作为普通观众，收到默认设置的远端用户视频。
  

注意：

• 该参数用于实现跨直播间连麦场景。连麦主播需要调用 joinChannelEx 方法，以观众身份加入对方的直播间，并将 isInteractiveAudience 设置为 true。
  
• 仅当用户角色为 CLIENT_ROLE_AUDIENCE 时，该参数生效。
  

customVideoTrackId

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

isAudioFilterable

设置是否让当前音频流根据音强算法参与选流。

• true：参与音强选流。如未开启音强选流功能，该参数不会生效。
  
• false：不参与音强选流。
  

注意： 如需启用该功能，请联系 sales@agora.io。