ChannelMediaOptions
- Unreal 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> publishMixedAudioTrack;
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() {}
}详情
SDK 支持在同一时间、同一 RtcConnection 中发布多路音频流、一路视频流。例如,publishMicrophoneTrack、publishCustomAudioTrack 和 publishMediaPlayerAudioTrack 可以同时为 true; publishCameraTrack、publishScreenCaptureVideo、publishScreenTrack、publishCustomVideoTrack 或 publishEncodedVideoTrack 之中同一时间只能有一个为 true。
注意: 建议你根据业务场景自行设置成员参数值,否则 SDK 会自动对成员参数进行赋值。
属性
| 参数名 | 描述 |
|---|---|
publishCameraTrack | 设置是否发布摄像头采集的视频:
|
publishSecondaryCameraTrack | 设置是否发布第二个摄像头采集的视频:
|
publishMicrophoneTrack | 设置是否发布麦克风采集到的音频:
注:
|
publishThirdCameraTrack | 设置是否发布第三个摄像头采集的视频:
注意: 该参数仅适用于 Android、Windows 和 macOS 平台。 |
publishFourthCameraTrack | 设置是否发布第四个摄像头采集的视频:
注意: 该参数仅适用于 Android、Windows 和 macOS 平台。 |
publishScreenTrack | 设置是否发布屏幕采集的视频:
注意: 该参数仅适用于 Windows 和 macOS 平台。 |
publishScreenCaptureVideo | 设置是否发布屏幕采集的视频:
注意: 该参数仅适用于 Android 和 iOS 平台。 |
publishScreenCaptureAudio | 设置是否发布屏幕采集的音频:
注意: 该参数仅适用于 Android 和 iOS 平台。 |
publishSecondaryScreenTrack | 设置是否发布第二个屏幕采集的视频:
|
publishThirdScreenTrack | 设置是否发布第三个屏幕采集的视频:
注意: 该参数仅适用于 Windows 和 macOS 平台。 |
publishFourthScreenTrack | 设置是否发布第四个屏幕采集的视频:
注意: 该参数仅适用于 Windows 和 macOS 平台。 |
publishTranscodedVideoTrack | 设置是否发布本地的转码视频:
|
publishMixedAudioTrack | 设置是否发布本地混音音频:
|
publishCustomAudioTrack | 设置是否发布自定义采集的音频:
|
publishCustomAudioTrackId | 待发布的自定义音频轨道的 ID,默认值为 0。你可以通过 createCustomAudioTrack 方法来获取自定义音频轨道 ID。 |
publishCustomVideoTrack | 设置是否发布自定义采集的视频:
|
publishEncodedVideoTrack | 设置是否发布编码后的视频:
|
publishMediaPlayerAudioTrack | 设置是否发布媒体播放器的音频:
|
publishMediaPlayerVideoTrack | 设置是否发布媒体播放器的视频:
|
autoSubscribeAudio | 设置是否自动订阅所有音频流:
|
autoSubscribeVideo | 设置是否自动订阅所有视频流:
|
enableAudioRecordingOrPlayout | 设置是否开启音频录制或播放:
注: 如果那你需要发布麦克风采集的音频流,请确保该参数设为 |
publishMediaPlayerId | 待发布的媒体播放器的 ID。默认值为 0。 |
clientRoleType | 用户角色。详见 CLIENT_ROLE_TYPE。 注: 角色为观众的用户无法在频道内发布音视频流。在直播场景下发流时,请确保你的用户角色已切换为主播。 |
audienceLatencyLevel | 观众端延时级别。详见 AUDIENCE_LATENCY_LEVEL_TYPE。 |
defaultVideoStreamType | 默认订阅的视频流类型: VIDEO_STREAM_TYPE。 |
channelProfile | 频道使用场景。详见 CHANNEL_PROFILE_TYPE。 |
audioDelayMs | 发送音频帧的延时(毫秒)。你可以通过该参数来设置需要发送的音频帧的延时,以确保音画同步。 如果要关闭延时,将此参数值设置为 0。 |
token | (可选)在服务端生成的用于鉴权的动态密钥。详见使用 Token 鉴权。 注意:
|
publishRhythmPlayerTrack | 设置是否发布虚拟节拍器声音至远端:
|
isInteractiveAudience | 是否开启互动观众模式:
注意:
|
customVideoTrackId | 调用 createCustomVideoTrack 方法返回的视频轨道 ID。默认值为 0。 |
isAudioFilterable |