agora::rtc::DirectCdnStreamingMediaOptions Struct Reference

Public Member Functions
	DirectCdnStreamingMediaOptions ()
	~DirectCdnStreamingMediaOptions ()
void	SetAll (const DirectCdnStreamingMediaOptions &change)
bool	operator== (const DirectCdnStreamingMediaOptions &o) const
DirectCdnStreamingMediaOptions &	operator= (const DirectCdnStreamingMediaOptions &replace)

Public Attributes
Optional< bool >	publishCameraTrack
Optional< bool >	publishMicrophoneTrack
Optional< bool >	publishCustomAudioTrack
Optional< bool >	publishCustomVideoTrack
Optional< bool >	publishMediaPlayerAudioTrack
Optional< int >	publishMediaPlayerId
Optional< video_track_id_t >	customVideoTrackId
Optional< bool >	publishScreenTrack
Optional< bool >	publishSecondaryScreenTrack
Optional< bool >	publishThirdScreenTrack
Optional< bool >	publishFourthScreenTrack
Optional< bool >	publishLoopbackAudioTrack
Optional< const char * >	publishLoopbackDeviceName

Detailed Description

The channel media options.

Constructor & Destructor Documentation

DirectCdnStreamingMediaOptions()

agora::rtc::DirectCdnStreamingMediaOptions::DirectCdnStreamingMediaOptions ( )

inline

~DirectCdnStreamingMediaOptions()

agora::rtc::DirectCdnStreamingMediaOptions::~DirectCdnStreamingMediaOptions ( )

inline

Member Function Documentation

SetAll()

void agora::rtc::DirectCdnStreamingMediaOptions::SetAll ( const DirectCdnStreamingMediaOptions &  change )

inline

operator==()

bool agora::rtc::DirectCdnStreamingMediaOptions::operator== ( const DirectCdnStreamingMediaOptions &  o ) const

inline

operator=()

DirectCdnStreamingMediaOptions& agora::rtc::DirectCdnStreamingMediaOptions::operator= ( const DirectCdnStreamingMediaOptions &  replace )

inline

Member Data Documentation

publishCameraTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishCameraTrack

Determines whether to publish the video of the camera track.

• true: Publish the video track of the camera capturer.
• false: (Default) Do not publish the video track of the camera capturer.

publishMicrophoneTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishMicrophoneTrack

Determines whether to publish the recorded audio.

• true: Publish the recorded audio.
• false: (Default) Do not publish the recorded audio.

publishCustomAudioTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishCustomAudioTrack

Determines whether to publish the audio of the custom audio track.

• true: Publish the audio of the custom audio track.
• false: (Default) Do not publish the audio of the custom audio track.

publishCustomVideoTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishCustomVideoTrack

Determines whether to publish the video of the custom video track.

• true: Publish the video of the custom video track.
• false: (Default) Do not publish the video of the custom video track.

publishMediaPlayerAudioTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishMediaPlayerAudioTrack

Determines whether to publish the audio track of media player source.

• true: Publish the audio track of media player source.
• false: (Default) Do not publish the audio track of media player source.

publishMediaPlayerId

Optional<int> agora::rtc::DirectCdnStreamingMediaOptions::publishMediaPlayerId

Determines which media player source should be published. You can get the MediaPlayerId after calling getMediaPlayerId() of AgoraMediaPlayer.

customVideoTrackId

Optional<video_track_id_t> agora::rtc::DirectCdnStreamingMediaOptions::customVideoTrackId

The custom video track id which will used to publish. You can get the VideoTrackId after calling createCustomVideoTrack() of IRtcEngine.

publishScreenTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishScreenTrack

Whether to publish the captured video from the screen: This parameter is for macOS and Windows only.

• true: Publish the captured video from the screen.
• false: (Default) Do not publish the captured video from the screen.

publishSecondaryScreenTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishSecondaryScreenTrack

Whether to publish the captured video from the secondary screen: This parameter is for macOS and Windows only.

• true: Publish the captured video from the secondary screen.
• false: (Default) Do not publish the captured video from the secondary screen.

publishThirdScreenTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishThirdScreenTrack

Whether to publish the captured video from the third screen: This parameter is for macOS and Windows only.

• true: Publish the captured video from the third screen.
• false: (Default) Do not publish the captured video from the third screen.

publishFourthScreenTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishFourthScreenTrack

Whether to publish the captured video from the fourth screen: This parameter is for macOS and Windows only.

• true: Publish the captured video from the fourth screen.
• false: (Default) Do not publish the captured video from the fourth screen.

publishLoopbackAudioTrack

Optional<bool> agora::rtc::DirectCdnStreamingMediaOptions::publishLoopbackAudioTrack

Whether to publish the audio played by the local loopback device. This parameter is for macOS and Windows only.

• true: Publish the audio track of local loopback track.
• false: (Default) Do not publish the local loopback track.

publishLoopbackDeviceName

Optional<const char*> agora::rtc::DirectCdnStreamingMediaOptions::publishLoopbackDeviceName

Pointer to the device name of the sound card. The default value is NULL (the default sound card).

• This parameter is for macOS and Windows only.
• macOS does not support loopback capturing of the default sound card. If you need to use this method, please use a virtual sound card and pass its name to the publishLoopbackDeviceName. Agora has tested and recommends using soundflower.