Agora RTC Objective-C API Reference  Refactor
AgoraMediaPlayerKit.h
Go to the documentation of this file.
1 //
2 // AgoraMediaPlayerKit.h
3 // AgoraMediaPlayer
4 //
5 // Copyright © 2019 agora. All rights reserved.
6 //
7 
8 #import <AudioToolbox/AudioToolbox.h>
9 #import <Foundation/Foundation.h>
10 #import <VideoToolbox/VideoToolbox.h>
11 #if TARGET_OS_IPHONE
12 #import <UIKit/UIKit.h>
13 typedef UIView View;
14 #elif TARGET_OS_MAC
15 #import <AppKit/AppKit.h>
16 typedef NSView View;
17 #endif
18 NS_ASSUME_NONNULL_BEGIN
20 typedef NS_ENUM(NSInteger, AgoraMediaPlayerState) {
37 };
39 typedef NS_ENUM(NSInteger, AgoraMediaPlayerError) {
66 };
70 typedef NS_ENUM(NSInteger, AgoraMediaPlayerEvent) {
77 };
78 
82 typedef NS_ENUM(NSUInteger, AgoraMediaPlayerMetaDataType) {
87 };
88 
90 typedef NS_ENUM(NSInteger, AgoraMediaPixelFormat) {
106 };
108 typedef NS_ENUM(NSInteger, AgoraMediaStreamType) {
117 };
119 typedef NS_ENUM(NSUInteger, AgoraMediaPlayerRenderMode) {
124 
130 };
131 @class AgoraMediaPlayer;
132 
133 @class AgoraMediaStreamInfo;
135 @protocol AgoraMediaPlayerDelegate <NSObject>
136 
137 @optional
138 
147 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
148  didChangedToState:(AgoraMediaPlayerState)state
149  error:(AgoraMediaPlayerError)error;
150 
160 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
161  didChangedToPosition:(NSInteger)position;
162 
169 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
170  didOccurEvent:(AgoraMediaPlayerEvent)event;
171 
185 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
186  metaDataType:(AgoraMediaPlayerMetaDataType) type
187  didReceiveData:(NSString *)data
188  length:(NSInteger)length;
199 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
200  didReceiveVideoFrame:(CVPixelBufferRef)pixelBuffer;
211 - (void)AgoraMediaPlayer:(AgoraMediaPlayer *_Nonnull)playerKit
212  didReceiveAudioFrame:(CMSampleBufferRef)audioFrame;
213 
214 @end
215 
219 __attribute__((visibility("default"))) @interface AgoraMediaStreamInfo : NSObject
221 @property(nonatomic, assign) NSInteger streamIndex;
223 @property(nonatomic, assign) AgoraMediaStreamType streamType;
225 @property(nonatomic, copy) NSString *_Nonnull codecName;
227 @property(nonatomic, copy) NSString *_Nullable language;
229 @property(nonatomic, assign) NSInteger videoFrameRate;
231 @property(nonatomic, assign) NSInteger videoBitRate;
233 @property(nonatomic, assign) NSInteger videoWidth;
235 @property(nonatomic, assign) NSInteger videoHeight;
237 @property(nonatomic, assign) NSInteger audioSampleRate;
239 @property(nonatomic, assign) NSInteger audioChannels;
241 @property(nonatomic, assign) NSInteger duration;
243 @property(nonatomic, assign) NSInteger rotation;
244 
245 @end
246 
248 __attribute__((visibility("default"))) @interface AgoraMediaPlayer : NSObject
254 @property(nonatomic, assign) BOOL mute;
256 @property(nonatomic, assign) NSInteger volume;
258 @property(nonatomic, readonly) AgoraMediaPlayerState state;
259 @property(nonatomic, weak) id<AgoraMediaPlayerDelegate> _Nullable delegate;
266 - (instancetype)initWithDelegate:(id<AgoraMediaPlayerDelegate>)delegate;
267 
272 - (void)setView:(View *_Nullable)view;
273 
278 - (void)setRenderMode:(AgoraMediaPlayerRenderMode)mode;
279 
287 - (void)open:(NSString *)url startPos:(NSInteger)startPos;
288 
294 - (void)play;
295 
300 - (void)pause;
301 
304 - (void)stop;
305 
313 - (void)seekToPosition:(NSInteger)position;
314 
324 - (int)mute:(bool)isMute;
325 
332 - (bool)getMute;
333 
340 - (int)adjustVolume:(int)volume;
341 
346 - (NSInteger)getPosition;
347 
353 - (NSInteger)getDuration;
354 
361 - (AgoraMediaPlayerState)getPlayerState;
362 
369 - (NSInteger)getStreamCount;
370 
379 - (AgoraMediaStreamInfo *_Nullable)getStreamByIndex:(int)index;
380 
381 
382 @end
383 
384 NS_ASSUME_NONNULL_END
AgoraMediaPlayerRenderModeHidden
@ AgoraMediaPlayerRenderModeHidden
Definition: AgoraMediaPlayerKit.h:123
AgoraMediaPlayerErrorVideoRenderFailed
@ AgoraMediaPlayerErrorVideoRenderFailed
Definition: AgoraMediaPlayerKit.h:57
AgoraMediaPlayerStateIdle
@ AgoraMediaPlayerStateIdle
Definition: AgoraMediaPlayerKit.h:22
AgoraMediaPlayerDelegate-p
Definition: AgoraMediaPlayerKit.h:135
AgoraMediaPlayerStatePaused
@ AgoraMediaPlayerStatePaused
Definition: AgoraMediaPlayerKit.h:30
AgoraMediaPlayerEvent
AgoraMediaPlayerEvent
Definition: AgoraMediaPlayerKit.h:70
AgoraMediaStreamTypeSubtitle
@ AgoraMediaStreamTypeSubtitle
Definition: AgoraMediaPlayerKit.h:116
AgoraMediaPlayerErrorInvalidConnectState
@ AgoraMediaPlayerErrorInvalidConnectState
Definition: AgoraMediaPlayerKit.h:63
AgoraMediaPlayerEventSeekComplete
@ AgoraMediaPlayerEventSeekComplete
Definition: AgoraMediaPlayerKit.h:74
AgoraMediaStreamTypeUnknow
@ AgoraMediaStreamTypeUnknow
Definition: AgoraMediaPlayerKit.h:110
AgoraMediaPlayerMetaDataType
AgoraMediaPlayerMetaDataType
Definition: AgoraMediaPlayerKit.h:82
AgoraMediaPlayerErrorSrcBufferUnderflow
@ AgoraMediaPlayerErrorSrcBufferUnderflow
Definition: AgoraMediaPlayerKit.h:65
View
UIView View
Definition: AgoraMediaPlayerKit.h:13
AgoraMediaPlayerStatePlaying
@ AgoraMediaPlayerStatePlaying
Definition: AgoraMediaPlayerKit.h:28
AgoraMediaPlayerErrorObjNotInitialized
@ AgoraMediaPlayerErrorObjNotInitialized
Definition: AgoraMediaPlayerKit.h:53
AgoraMediaPlayerStateFailed
@ AgoraMediaPlayerStateFailed
Definition: AgoraMediaPlayerKit.h:36
AgoraMediaPixelFormat
AgoraMediaPixelFormat
Definition: AgoraMediaPlayerKit.h:90
AgoraMediaPixelFormatUnknown
@ AgoraMediaPixelFormatUnknown
Definition: AgoraMediaPlayerKit.h:93
AgoraMediaPlayerRenderMode
AgoraMediaPlayerRenderMode
Definition: AgoraMediaPlayerKit.h:119
AgoraMediaPixelFormatI420
@ AgoraMediaPixelFormatI420
Definition: AgoraMediaPlayerKit.h:96
AgoraMediaPlayerErrorUrlNotFound
@ AgoraMediaPlayerErrorUrlNotFound
Definition: AgoraMediaPlayerKit.h:61
AgoraMediaStreamTypeAudio
@ AgoraMediaStreamTypeAudio
Definition: AgoraMediaPlayerKit.h:114
AgoraMediaPlayerEventSeekError
@ AgoraMediaPlayerEventSeekError
Definition: AgoraMediaPlayerKit.h:76
AgoraMediaPlayerError
AgoraMediaPlayerError
Definition: AgoraMediaPlayerKit.h:39
AgoraMediaPlayerStateOpenCompleted
@ AgoraMediaPlayerStateOpenCompleted
Definition: AgoraMediaPlayerKit.h:26
AgoraMediaPlayerState
AgoraMediaPlayerState
Definition: AgoraMediaPlayerKit.h:20
AgoraMediaPixelFormatBGRA
@ AgoraMediaPixelFormatBGRA
Definition: AgoraMediaPlayerKit.h:99
AgoraMediaPlayerMetaDataTypeUnknown
@ AgoraMediaPlayerMetaDataTypeUnknown
Definition: AgoraMediaPlayerKit.h:84
AgoraMediaPlayerStateOpening
@ AgoraMediaPlayerStateOpening
Definition: AgoraMediaPlayerKit.h:24
AgoraMediaPlayerErrorCodecNotSupported
@ AgoraMediaPlayerErrorCodecNotSupported
Definition: AgoraMediaPlayerKit.h:55
AgoraMediaPlayerStateStopped
@ AgoraMediaPlayerStateStopped
Definition: AgoraMediaPlayerKit.h:34
AgoraMediaPixelFormatI422
@ AgoraMediaPixelFormatI422
Definition: AgoraMediaPlayerKit.h:102
AgoraMediaPlayerErrorNoSource
@ AgoraMediaPlayerErrorNoSource
Definition: AgoraMediaPlayerKit.h:47
AgoraMediaPlayerErrorInvalidMediaSource
@ AgoraMediaPlayerErrorInvalidMediaSource
Definition: AgoraMediaPlayerKit.h:49
AgoraMediaPlayerErrorNone
@ AgoraMediaPlayerErrorNone
Definition: AgoraMediaPlayerKit.h:41
AgoraMediaPlayerErrorInvalidState
@ AgoraMediaPlayerErrorInvalidState
Definition: AgoraMediaPlayerKit.h:59
AgoraMediaPlayerRenderModeFit
@ AgoraMediaPlayerRenderModeFit
Definition: AgoraMediaPlayerKit.h:129
AgoraMediaPlayerStatePlayBackCompleted
@ AgoraMediaPlayerStatePlayBackCompleted
Definition: AgoraMediaPlayerKit.h:32
AgoraMediaPixelFormatNV12
@ AgoraMediaPixelFormatNV12
Definition: AgoraMediaPlayerKit.h:105
AgoraMediaPlayerErrorUnknowStreamType
@ AgoraMediaPlayerErrorUnknowStreamType
Definition: AgoraMediaPlayerKit.h:51
AgoraMediaStreamTypeVideo
@ AgoraMediaStreamTypeVideo
Definition: AgoraMediaPlayerKit.h:112
AgoraMediaPlayerMetaDataTypeSEI
@ AgoraMediaPlayerMetaDataTypeSEI
Definition: AgoraMediaPlayerKit.h:86
AgoraMediaPlayerEventSeekBegin
@ AgoraMediaPlayerEventSeekBegin
Definition: AgoraMediaPlayerKit.h:72
AgoraMediaPlayerErrorInternal
@ AgoraMediaPlayerErrorInternal
Definition: AgoraMediaPlayerKit.h:45
AgoraMediaStreamType
AgoraMediaStreamType
Definition: AgoraMediaPlayerKit.h:108
AgoraMediaPlayerErrorInvalidArguments
@ AgoraMediaPlayerErrorInvalidArguments
Definition: AgoraMediaPlayerKit.h:43