Agora C++ API Reference for All Platforms
AgoraMediaPlayerTypes.h
1 //
2 // Agora Engine SDK
3 //
4 // Created by Sting Feng in 2020-05.
5 // Copyright (c) 2017 Agora.io. All rights reserved.
6 
7 #pragma once // NOLINT(build/header_guard)
8 
9 #include <cstring>
10 #if __cplusplus >= 201103L || (defined(_MSC_VER) && _MSC_VER >= 1800)
11 #include <cstdint>
12 #endif
13 
18 #define KEY_PLAYER_REAL_TIME_STREAM_ANALYZE_DURATION "analyze_duration"
19 
24 #define KEY_PLAYER_ENABLE_AUDIO "enable_audio"
25 
30 #define KEY_PLAYER_ENABLE_VIDEO "enable_video"
31 
36 #define KEY_PLAYER_ENABLE_SEARCH_METADATA "enable_search_metadata"
37 
42 #define KEY_PLAYER_SEI_FILTER_TYPE "set_sei_filter_type"
43 
44 namespace agora {
45 
46 namespace media {
47 
48 namespace base {
49 static const uint8_t kMaxCharBufferLength = 50;
100 };
148 };
149 
173 };
174 
192 };
193 
229 };
230 
238 
241 
244 
247 
250 
253 
256 
259 
262 
265 
268 
271 
273  int64_t duration;
274 
277  videoFrameRate(0),
278  videoBitRate(0),
279  videoWidth(0),
280  videoHeight(0),
281  videoRotation(0),
282  audioSampleRate(0),
283  audioChannels(0),
285  duration(0) {
286  memset(codecName, 0, sizeof(codecName));
287  memset(language, 0, sizeof(language));
288  }
289 };
290 
302 };
303 
304 } // namespace base
305 } // namespace media
306 } // namespace agora
agora::media::base::PLAYER_EVENT_SEEK_BEGIN
@ PLAYER_EVENT_SEEK_BEGIN
Definition: AgoraMediaPlayerTypes.h:201
agora::media::base::PLAYER_STATE_IDLE
@ PLAYER_STATE_IDLE
Definition: AgoraMediaPlayerTypes.h:57
agora::media::base::PlayerStreamInfo::videoFrameRate
int videoFrameRate
Definition: AgoraMediaPlayerTypes.h:249
agora::media::base::PLAYBACK_SPEED_200_PERCENT
@ PLAYBACK_SPEED_200_PERCENT
Definition: AgoraMediaPlayerTypes.h:172
agora::media::base::PLAYER_ERROR_OBJ_NOT_INITIALIZED
@ PLAYER_ERROR_OBJ_NOT_INITIALIZED
Definition: AgoraMediaPlayerTypes.h:126
agora::media::base::STREAM_TYPE_UNKNOWN
@ STREAM_TYPE_UNKNOWN
Definition: AgoraMediaPlayerTypes.h:182
agora::media::base::PLAYER_STATE_DO_NOTHING_INTERNAL
@ PLAYER_STATE_DO_NOTHING_INTERNAL
Definition: AgoraMediaPlayerTypes.h:96
agora::media::base::PlayerStreamInfo::streamType
MEDIA_STREAM_TYPE streamType
Definition: AgoraMediaPlayerTypes.h:240
agora::media::base::PlayerStreamInfo::PlayerStreamInfo
PlayerStreamInfo()
Definition: AgoraMediaPlayerTypes.h:275
agora::media::base::PLAYER_ERROR_NO_RESOURCE
@ PLAYER_ERROR_NO_RESOURCE
Definition: AgoraMediaPlayerTypes.h:117
agora::media::base::PlayerStreamInfo::videoRotation
int videoRotation
Definition: AgoraMediaPlayerTypes.h:261
agora::media::base::PLAYER_METADATA_TYPE_SEI
@ PLAYER_METADATA_TYPE_SEI
Definition: AgoraMediaPlayerTypes.h:301
agora::media::base::STREAM_TYPE_VIDEO
@ STREAM_TYPE_VIDEO
Definition: AgoraMediaPlayerTypes.h:185
agora::media::base::PlayerStreamInfo::videoWidth
int videoWidth
Definition: AgoraMediaPlayerTypes.h:255
agora::media::base::PLAYER_ERROR_UNKNOWN_STREAM_TYPE
@ PLAYER_ERROR_UNKNOWN_STREAM_TYPE
Definition: AgoraMediaPlayerTypes.h:123
agora::media::base::PLAYER_ERROR_INVALID_ARGUMENTS
@ PLAYER_ERROR_INVALID_ARGUMENTS
Definition: AgoraMediaPlayerTypes.h:111
agora::media::base::PLAYBACK_SPEED_50_PERCENT
@ PLAYBACK_SPEED_50_PERCENT
Definition: AgoraMediaPlayerTypes.h:160
agora::media::base::PLAYER_ERROR_INVALID_STATE
@ PLAYER_ERROR_INVALID_STATE
Definition: AgoraMediaPlayerTypes.h:135
agora::media::base::PLAYER_STATE_STOPPED
@ PLAYER_STATE_STOPPED
Definition: AgoraMediaPlayerTypes.h:78
agora::media::base::PLAYER_EVENT_SEEK_COMPLETE
@ PLAYER_EVENT_SEEK_COMPLETE
Definition: AgoraMediaPlayerTypes.h:204
agora::media::base::PLAYER_EVENT_FREEZE_START
@ PLAYER_EVENT_FREEZE_START
Definition: AgoraMediaPlayerTypes.h:225
agora::media::base::PLAYER_EVENT_AUDIO_PUBLISHED
@ PLAYER_EVENT_AUDIO_PUBLISHED
Definition: AgoraMediaPlayerTypes.h:213
agora::media::base::kMaxCharBufferLength
static const uint8_t kMaxCharBufferLength
Definition: AgoraMediaPlayerTypes.h:49
agora
Definition: AgoraAtomicOps.h:21
agora::media::base::PlayerStreamInfo::audioChannels
int audioChannels
Definition: AgoraMediaPlayerTypes.h:267
agora::media::base::PLAYER_STATE_GETTING_INTERNAL
@ PLAYER_STATE_GETTING_INTERNAL
Definition: AgoraMediaPlayerTypes.h:90
agora::media::base::MEDIA_PLAYER_PLAYBACK_SPEED
MEDIA_PLAYER_PLAYBACK_SPEED
The playback speed.
Definition: AgoraMediaPlayerTypes.h:154
agora::media::base::PlayerStreamInfo::audioBitsPerSample
int audioBitsPerSample
Definition: AgoraMediaPlayerTypes.h:270
agora::media::base::PLAYBACK_SPEED_75_PERCENT
@ PLAYBACK_SPEED_75_PERCENT
Definition: AgoraMediaPlayerTypes.h:163
agora::media::base::PLAYER_ERROR_INTERRUPTED
@ PLAYER_ERROR_INTERRUPTED
Definition: AgoraMediaPlayerTypes.h:147
agora::media::base::PlayerStreamInfo::streamIndex
int streamIndex
Definition: AgoraMediaPlayerTypes.h:237
agora::media::base::PLAYER_ERROR_INTERNAL
@ PLAYER_ERROR_INTERNAL
Definition: AgoraMediaPlayerTypes.h:114
agora::media::base::PLAYER_STATE_OPEN_COMPLETED
@ PLAYER_STATE_OPEN_COMPLETED
Definition: AgoraMediaPlayerTypes.h:63
agora::media::base::PLAYER_ERROR_CODEC_NOT_SUPPORTED
@ PLAYER_ERROR_CODEC_NOT_SUPPORTED
Definition: AgoraMediaPlayerTypes.h:129
agora::media::base::PLAYER_STATE_PAUSING_INTERNAL
@ PLAYER_STATE_PAUSING_INTERNAL
Definition: AgoraMediaPlayerTypes.h:81
agora::media::base::PlayerStreamInfo::videoBitRate
int videoBitRate
Definition: AgoraMediaPlayerTypes.h:252
agora::media::base::MEDIA_PLAYER_STATE
MEDIA_PLAYER_STATE
The playback state.
Definition: AgoraMediaPlayerTypes.h:54
agora::media::base::PLAYER_STATE_OPENING
@ PLAYER_STATE_OPENING
Definition: AgoraMediaPlayerTypes.h:60
agora::media::base::PLAYER_ERROR_INVALID_MEDIA_SOURCE
@ PLAYER_ERROR_INVALID_MEDIA_SOURCE
Definition: AgoraMediaPlayerTypes.h:120
agora::media::base::PlayerStreamInfo
The information of the media stream object.
Definition: AgoraMediaPlayerTypes.h:235
agora::media::base::PLAYER_EVENT_AUDIO_TRACK_CHANGED
@ PLAYER_EVENT_AUDIO_TRACK_CHANGED
Definition: AgoraMediaPlayerTypes.h:216
agora::media::base::PLAYER_EVENT_BUFFER_LOW
@ PLAYER_EVENT_BUFFER_LOW
Definition: AgoraMediaPlayerTypes.h:219
agora::media::base::PLAYER_ERROR_INVALID_CONNECTION_STATE
@ PLAYER_ERROR_INVALID_CONNECTION_STATE
Definition: AgoraMediaPlayerTypes.h:141
agora::media::base::PLAYBACK_SPEED_150_PERCENT
@ PLAYBACK_SPEED_150_PERCENT
Definition: AgoraMediaPlayerTypes.h:169
agora::media::base::PLAYER_STATE_PLAYBACK_COMPLETED
@ PLAYER_STATE_PLAYBACK_COMPLETED
Definition: AgoraMediaPlayerTypes.h:72
agora::media::base::MEDIA_PLAYER_METADATA_TYPE
MEDIA_PLAYER_METADATA_TYPE
The type of the media metadata.
Definition: AgoraMediaPlayerTypes.h:295
agora::media::base::PLAYER_METADATA_TYPE_UNKNOWN
@ PLAYER_METADATA_TYPE_UNKNOWN
Definition: AgoraMediaPlayerTypes.h:298
agora::media::base::PLAYBACK_SPEED_ORIGINAL
@ PLAYBACK_SPEED_ORIGINAL
Definition: AgoraMediaPlayerTypes.h:157
agora::media::base::PLAYER_ERROR_NONE
@ PLAYER_ERROR_NONE
Definition: AgoraMediaPlayerTypes.h:108
agora::media::base::PlayerStreamInfo::duration
int64_t duration
Definition: AgoraMediaPlayerTypes.h:273
agora::media::base::PLAYER_EVENT_VIDEO_PUBLISHED
@ PLAYER_EVENT_VIDEO_PUBLISHED
Definition: AgoraMediaPlayerTypes.h:210
agora::media::base::PLAYER_STATE_SEEKING_INTERNAL
@ PLAYER_STATE_SEEKING_INTERNAL
Definition: AgoraMediaPlayerTypes.h:87
agora::media::base::STREAM_TYPE_SUBTITLE
@ STREAM_TYPE_SUBTITLE
Definition: AgoraMediaPlayerTypes.h:191
agora::media::base::PLAYER_ERROR_SRC_BUFFER_UNDERFLOW
@ PLAYER_ERROR_SRC_BUFFER_UNDERFLOW
Definition: AgoraMediaPlayerTypes.h:144
agora::media::base::PLAYER_STATE_FAILED
@ PLAYER_STATE_FAILED
Definition: AgoraMediaPlayerTypes.h:99
agora::media::base::PlayerStreamInfo::audioSampleRate
int audioSampleRate
Definition: AgoraMediaPlayerTypes.h:264
agora::media::base::PlayerStreamInfo::language
char language[kMaxCharBufferLength]
Definition: AgoraMediaPlayerTypes.h:246
agora::media::base::PLAYER_STATE_STOPPING_INTERNAL
@ PLAYER_STATE_STOPPING_INTERNAL
Definition: AgoraMediaPlayerTypes.h:84
agora::media::base::PLAYER_STATE_PAUSED
@ PLAYER_STATE_PAUSED
Definition: AgoraMediaPlayerTypes.h:69
agora::media::base::MEDIA_STREAM_TYPE
MEDIA_STREAM_TYPE
The type of the media stream.
Definition: AgoraMediaPlayerTypes.h:179
agora::media::base::PLAYER_EVENT_BUFFER_RECOVER
@ PLAYER_EVENT_BUFFER_RECOVER
Definition: AgoraMediaPlayerTypes.h:222
agora::media::base::PLAYER_EVENT_SEEK_ERROR
@ PLAYER_EVENT_SEEK_ERROR
Definition: AgoraMediaPlayerTypes.h:207
agora::media::base::MEDIA_PLAYER_EVENT
MEDIA_PLAYER_EVENT
The playback event.
Definition: AgoraMediaPlayerTypes.h:198
agora::media::base::PLAYER_ERROR_URL_NOT_FOUND
@ PLAYER_ERROR_URL_NOT_FOUND
Definition: AgoraMediaPlayerTypes.h:138
agora::media::base::PLAYER_EVENT_FREEZE_STOP
@ PLAYER_EVENT_FREEZE_STOP
Definition: AgoraMediaPlayerTypes.h:228
agora::media::base::PlayerStreamInfo::codecName
char codecName[kMaxCharBufferLength]
Definition: AgoraMediaPlayerTypes.h:243
agora::media::base::PLAYER_STATE_NONE_INTERNAL
@ PLAYER_STATE_NONE_INTERNAL
Definition: AgoraMediaPlayerTypes.h:93
agora::media::base::PLAYER_ERROR_VIDEO_RENDER_FAILED
@ PLAYER_ERROR_VIDEO_RENDER_FAILED
Definition: AgoraMediaPlayerTypes.h:132
agora::media::base::MEDIA_PLAYER_ERROR
MEDIA_PLAYER_ERROR
Player error code.
Definition: AgoraMediaPlayerTypes.h:105
agora::media::base::STREAM_TYPE_AUDIO
@ STREAM_TYPE_AUDIO
Definition: AgoraMediaPlayerTypes.h:188
agora::media::base::PLAYER_STATE_PLAYING
@ PLAYER_STATE_PLAYING
Definition: AgoraMediaPlayerTypes.h:66
agora::media::base::PlayerStreamInfo::videoHeight
int videoHeight
Definition: AgoraMediaPlayerTypes.h:258
agora::media::base::PLAYBACK_SPEED_125_PERCENT
@ PLAYBACK_SPEED_125_PERCENT
Definition: AgoraMediaPlayerTypes.h:166
agora::media::base::PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED
@ PLAYER_STATE_PLAYBACK_ALL_LOOPS_COMPLETED
Definition: AgoraMediaPlayerTypes.h:75