On-premise Recording SDK v3.0.6 API Reference for Linux (C++)
Classes | Namespaces | Typedefs | Enumerations
IAgoraLinuxSdkCommon.h File Reference

Go to the source code of this file.

Classes
class   agora::linuxsdk::IEngine
 
class   agora::linuxsdk::IEngineConfig
 
struct   agora::linuxsdk::UserInfo
 
struct   agora::linuxsdk::AudioVolumeInfo
 
struct   agora::linuxsdk::RemoteVideoStats
 
struct   agora::linuxsdk::RemoteAudioStats
 
struct   agora::linuxsdk::RecordingStats
 
class   agora::linuxsdk::AudioPcmFrame
 
class   agora::linuxsdk::AudioAacFrame
 
struct   agora::linuxsdk::AudioFrame
 
class   agora::linuxsdk::VideoYuvFrame
 
struct   agora::linuxsdk::VideoH264Frame
 
struct   agora::linuxsdk::VideoH265Frame
 
struct   agora::linuxsdk::VideoJpgFrame
 
struct   agora::linuxsdk::VideoJpgFile
 
struct   agora::linuxsdk::VideoFrame
 
struct   agora::linuxsdk::LiteraWatermarkConfig
 
struct   agora::linuxsdk::TimestampWatermarkConfig
 
struct   agora::linuxsdk::ImageWatermarkConfig
 
struct   agora::linuxsdk::WatermarkConfig
 
union   agora::linuxsdk::WatermarkConfig::WatermarkConfigUnion
 
struct   agora::linuxsdk::VideoMixingLayout
 
struct   agora::linuxsdk::VideoMixingLayout::Region
 
struct   agora::linuxsdk::UserJoinInfos
 

Namespaces
  agora
 
  agora::linuxsdk
 

Typedefs
typedef unsigned char  agora::linuxsdk::uchar_t
 
typedef unsigned int  agora::linuxsdk::uint_t
 
typedef unsigned int  agora::linuxsdk::uid_t
 
typedef uint64_t  agora::linuxsdk::u64_t
 
typedef struct agora::linuxsdk::VideoMixingLayout  agora::linuxsdk::VideoMixingLayout
 
typedef struct agora::linuxsdk::UserJoinInfos  agora::linuxsdk::UserJoinInfos
 

Enumerations
enum   agora::linuxsdk::ERROR_CODE_TYPE { agora::linuxsdk::ERR_OK = 0 , agora::linuxsdk::ERR_FAILED = 1 , agora::linuxsdk::ERR_INVALID_ARGUMENT = 2 , agora::linuxsdk::ERR_INTERNAL_FAILED = 3 }
 
enum   agora::linuxsdk::STAT_CODE_TYPE {
  agora::linuxsdk::STAT_OK = 0 , agora::linuxsdk::STAT_ERR_FROM_ENGINE = 1 , agora::linuxsdk::STAT_ERR_ARS_JOIN_CHANNEL = 2 , agora::linuxsdk::STAT_ERR_CREATE_PROCESS = 3 ,
  agora::linuxsdk::STAT_ERR_MIXED_INVALID_VIDEO_PARAM = 4 , agora::linuxsdk::STAT_ERR_NULL_POINTER = 5 , agora::linuxsdk::STAT_ERR_PROXY_SERVER_INVALID_PARAM = 6 , agora::linuxsdk::STAT_POLL_ERR = 0x8 ,
  agora::linuxsdk::STAT_POLL_HANG_UP = 0x10 , agora::linuxsdk::STAT_POLL_NVAL = 0x20
}
 
enum   agora::linuxsdk::LEAVE_PATH_CODE {
  agora::linuxsdk::LEAVE_CODE_INIT = 0 , agora::linuxsdk::LEAVE_CODE_SIG = 1<<1 , agora::linuxsdk::LEAVE_CODE_NO_USERS = 1<<2 , agora::linuxsdk::LEAVE_CODE_TIMER_CATCH = 1<<3 ,
  agora::linuxsdk::LEAVE_CODE_CLIENT_LEAVE = 1 << 4
}
 
enum   agora::linuxsdk::WARN_CODE_TYPE {
  agora::linuxsdk::WARN_NO_AVAILABLE_CHANNEL = 103 , agora::linuxsdk::WARN_LOOKUP_CHANNEL_TIMEOUT = 104 , agora::linuxsdk::WARN_LOOKUP_CHANNEL_REJECTED = 105 , agora::linuxsdk::WARN_OPEN_CHANNEL_TIMEOUT = 106 ,
  agora::linuxsdk::WARN_OPEN_CHANNEL_REJECTED = 107 , agora::linuxsdk::WARN_RECOVERY_CORE_SERVICE_FAILURE = 108 , agora::linuxsdk::WARN_DECRYPTION_FAILED = 120
}
 
enum   agora::linuxsdk::CHANNEL_PROFILE_TYPE { agora::linuxsdk::CHANNEL_PROFILE_COMMUNICATION = 0 , agora::linuxsdk::CHANNEL_PROFILE_LIVE_BROADCASTING = 1 }
 
enum   agora::linuxsdk::USER_OFFLINE_REASON_TYPE { agora::linuxsdk::USER_OFFLINE_QUIT = 0 , agora::linuxsdk::USER_OFFLINE_DROPPED = 1 , agora::linuxsdk::USER_OFFLINE_BECOME_AUDIENCE = 2 }
 
enum   agora::linuxsdk::REMOTE_VIDEO_STREAM_TYPE { agora::linuxsdk::REMOTE_VIDEO_STREAM_HIGH = 0 , agora::linuxsdk::REMOTE_VIDEO_STREAM_LOW = 1 }
 
enum   agora::linuxsdk::VIDEO_FORMAT_TYPE {
  agora::linuxsdk::VIDEO_FORMAT_DEFAULT_TYPE = 0 , agora::linuxsdk::VIDEO_FORMAT_H264_FRAME_TYPE = 1 , agora::linuxsdk::VIDEO_FORMAT_ENCODED_FRAME_TYPE = VIDEO_FORMAT_H264_FRAME_TYPE , agora::linuxsdk::VIDEO_FORMAT_YUV_FRAME_TYPE = 2 ,
  agora::linuxsdk::VIDEO_FORMAT_JPG_FRAME_TYPE = 3 , agora::linuxsdk::VIDEO_FORMAT_JPG_FILE_TYPE = 4 , agora::linuxsdk::VIDEO_FORMAT_JPG_VIDEO_FILE_TYPE = 5
}
 
enum   agora::linuxsdk::AUDIO_FORMAT_TYPE { agora::linuxsdk::AUDIO_FORMAT_DEFAULT_TYPE = 0 , agora::linuxsdk::AUDIO_FORMAT_AAC_FRAME_TYPE = 1 , agora::linuxsdk::AUDIO_FORMAT_PCM_FRAME_TYPE = 2 , agora::linuxsdk::AUDIO_FORMAT_MIXED_PCM_FRAME_TYPE = 3 }
 
enum   agora::linuxsdk::AUDIO_FRAME_TYPE { agora::linuxsdk::AUDIO_FRAME_RAW_PCM = 0 , agora::linuxsdk::AUDIO_FRAME_AAC = 1 }
 
enum   agora::linuxsdk::MEMORY_TYPE { agora::linuxsdk::STACK_MEM_TYPE = 0 , agora::linuxsdk::HEAP_MEM_TYPE = 1 }
 
enum   agora::linuxsdk::VIDEO_FRAME_TYPE {
  agora::linuxsdk::VIDEO_FRAME_RAW_YUV = 0 , agora::linuxsdk::VIDEO_FRAME_H264 = 1 , agora::linuxsdk::VIDEO_FRAME_JPG = 2 , agora::linuxsdk::VIDEO_FRAME_H265 = 3 ,
  agora::linuxsdk::VIDEO_JPG_FILE = 4
}
 
enum   agora::linuxsdk::SERVICE_MODE { agora::linuxsdk::RECORDING_MODE = 0 , agora::linuxsdk::SERVER_MODE = 1 , agora::linuxsdk::IOT_MODE = 2 }
 
enum   agora::linuxsdk::TRIGGER_MODE_TYPE { agora::linuxsdk::AUTOMATICALLY_MODE = 0 , agora::linuxsdk::MANUALLY_MODE = 1 }
 
enum   agora::linuxsdk::LANGUAGE_TYPE { agora::linuxsdk::CPP_LANG = 0 , agora::linuxsdk::JAVA_LANG = 1 }
 
enum   agora::linuxsdk::AUDIO_PROFILE_TYPE { agora::linuxsdk::AUDIO_PROFILE_DEFAULT = 0 , agora::linuxsdk::AUDIO_PROFILE_HIGH_QUALITY = 1 , agora::linuxsdk::AUDIO_PROFILE_HIGH_QUALITY_STEREO = 2 }
 
enum   agora::linuxsdk::agora_log_level {
  agora::linuxsdk::AGORA_LOG_LEVEL_FATAL = 1 , agora::linuxsdk::AGORA_LOG_LEVEL_ERROR = 2 , agora::linuxsdk::AGORA_LOG_LEVEL_WARN = 3 , agora::linuxsdk::AGORA_LOG_LEVEL_NOTICE = 4 ,
  agora::linuxsdk::AGORA_LOG_LEVEL_INFO = 5 , agora::linuxsdk::AGORA_LOG_LEVEL_DEBUG = 6
}
 
enum   agora::linuxsdk::RemoteStreamStateChangedReason { agora::linuxsdk::REASON_REMOTE_STREAM_STARTED , agora::linuxsdk::REASON_REMOTE_STREAM_STOPPED }
 
enum   agora::linuxsdk::RemoteStreamState { agora::linuxsdk::REMOTE_STREAM_STATE_RUNNING , agora::linuxsdk::REMOTE_STREAM_STATE_STOPPED }
 
enum   agora::linuxsdk::MIXED_AV_CODEC_TYPE {
  agora::linuxsdk::MIXED_AV_DEFAULT = 0 , agora::linuxsdk::MIXED_AV_CODEC_V1 = 1 , agora::linuxsdk::MIXED_AV_CODEC_V2 = 2 , agora::linuxsdk::AV_CODEC_INDIVIDUAL_TS_ONLY = 4 ,
  agora::linuxsdk::AV_CODEC_INDIVIDUAL_TS_AND_MP4 = 5 , agora::linuxsdk::AV_CODEC_MIXED_TS_ONLY = 6 , agora::linuxsdk::AV_CODEC_MIXED_TS_AND_MP4 = 7
}
 
enum   agora::linuxsdk::ClientRoleType { agora::linuxsdk::CLIENT_ROLE_BROADCASTER = 1 , agora::linuxsdk::CLIENT_ROLE_AUDIENCE =2 }
 
enum   agora::linuxsdk::ConnectionStateType {
  agora::linuxsdk::CONNECTION_STATE_DISCONNECTED = 1 , agora::linuxsdk::CONNECTION_STATE_CONNECTING = 2 , agora::linuxsdk::CONNECTION_STATE_CONNECTED = 3 , agora::linuxsdk::CONNECTION_STATE_RECONNECTING = 4 ,
  agora::linuxsdk::CONNECTION_STATE_FAILED = 5
}
 
enum   agora::linuxsdk::ConnectionChangedReasonType {
  agora::linuxsdk::CONNECTION_CHANGED_CONNECTING = 0 , agora::linuxsdk::CONNECTION_CHANGED_JOIN_SUCCESS = 1 , agora::linuxsdk::CONNECTION_CHANGED_INTERRUPTED = 2 , agora::linuxsdk::CONNECTION_CHANGED_BANNED_BY_SERVER = 3 ,
  agora::linuxsdk::CONNECTION_CHANGED_JOIN_FAILED = 4 , agora::linuxsdk::CONNECTION_CHANGED_LEAVE_CHANNEL = 5
}
 
enum   agora::linuxsdk::MAX_USER_ACCOUNT_LENGTH_TYPE { agora::linuxsdk::MAX_USER_ACCOUNT_LENGTH = 256 }
 
enum   agora::linuxsdk::WatermarkType { agora::linuxsdk::WATERMARK_TYPE_LITERA , agora::linuxsdk::WATERMARK_TYPE_TIMESTAMP , agora::linuxsdk::WATERMARK_TYPE_IMAGE }
 
enum   agora::linuxsdk::UID_LIST_TYPE { agora::linuxsdk::UID_SUBSCRIBE_WHITE_LIST = 0 , agora::linuxsdk::UID_SUBSCRIBE_BLACK_LIST }
 
Generated by doxygen 1.9.1