Server Gateway SDK v3.8.202.20 for Linux C++
Public Member Functions | Public Attributes | List of all members
agora::rtc::VideoSubscriptionOptions Struct Reference

#include <AgoraBase.h>

Public Member Functions

 VideoSubscriptionOptions ()
 
 VideoSubscriptionOptions (VIDEO_STREAM_TYPE streamtype)
 
 VideoSubscriptionOptions (VIDEO_STREAM_TYPE streamtype, bool encoded_only)
 

Public Attributes

VIDEO_STREAM_TYPE type
 
bool encodedFrameOnly
 

Detailed Description

Video subscription options.

Constructor & Destructor Documentation

◆ VideoSubscriptionOptions() [1/3]

agora::rtc::VideoSubscriptionOptions::VideoSubscriptionOptions ( )
inline

◆ VideoSubscriptionOptions() [2/3]

agora::rtc::VideoSubscriptionOptions::VideoSubscriptionOptions ( VIDEO_STREAM_TYPE  streamtype)
inlineexplicit

◆ VideoSubscriptionOptions() [3/3]

agora::rtc::VideoSubscriptionOptions::VideoSubscriptionOptions ( VIDEO_STREAM_TYPE  streamtype,
bool  encoded_only 
)
inline

Member Data Documentation

◆ encodedFrameOnly

bool agora::rtc::VideoSubscriptionOptions::encodedFrameOnly

Whether to subscribe to encoded video data only:

  • true: Subscribe to encoded video data only.
  • false: (Default) Subscribe to decoded video data only.

◆ type

VIDEO_STREAM_TYPE agora::rtc::VideoSubscriptionOptions::type

The type of the video stream to subscribe to.

The default value is VIDEO_STREAM_HIGH, which means the high-quality video stream.


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