Video SDK v3.7.1 API Reference for Unity
Public Attributes | List of all members
agora_gaming_rtc.ChannelMediaOptions Class Reference

Public Attributes

bool autoSubscribeAudio
 
bool autoSubscribeVideo
 
bool publishLocalAudio
 
bool publishLocalVideo
 

Detailed Description

The channel media options.

Constructor & Destructor Documentation

◆ ChannelMediaOptions()

agora_gaming_rtc.ChannelMediaOptions.ChannelMediaOptions ( bool  _autoSubscribeAudio = true,
bool  _autoSubscribeVideo = false,
bool  _publishLocalAudio = true,
bool  _publishLocalVideo = true 
)

Member Data Documentation

◆ autoSubscribeAudio

bool agora_gaming_rtc.ChannelMediaOptions.autoSubscribeAudio

Determines whether to subscribe to audio streams when the user joins the channel:

  • true: (Default) Subscribe.
  • false: Do not subscribe.

This member serves a similar function to the MuteAllRemoteAudioStreams method. After joining the channel, you can call the MuteAllRemoteAudioStreams method to set whether to subscribe to audio streams in the channel.

◆ autoSubscribeVideo

bool agora_gaming_rtc.ChannelMediaOptions.autoSubscribeVideo

Determines whether to subscribe to video streams when the user joins the channel:

  • true: (Default) Subscribe.
  • false: Do not subscribe.

This member serves a similar function to the MuteAllRemoteVideoStreams method. After joining the channel, you can call the MuteAllRemoteVideoStreams method to set whether to subscribe to video streams in the channel.

◆ publishLocalAudio

bool agora_gaming_rtc.ChannelMediaOptions.publishLocalAudio

whether to publish the local audio stream when the user joins a channel:

  • true: (Default) Publish. -false: Do not publish.

This member serves a similar function to the MuteLocalAudioStream method. After the user joins the channel, you can call the MuteLocalAudioStream method to set whether to publish the local audio stream in the channel.

◆ publishLocalVideo

bool agora_gaming_rtc.ChannelMediaOptions.publishLocalVideo

whether to publish the local video stream when the user joins a channel:

  • true: (Default) Publish. -false: Do not publish.

This member serves a similar function to the MuteLocalVideoStream method. After the user joins the channel, you can call the MuteLocalVideoStream method to set whether to publish the local video stream in the channel.


The documentation for this class was generated from the following file: