AgoraMediaIO.h

Go to the documentation of this file.

//
//  AgoraMediaIO.h
//  AgoraRtcEngineKit
//
//  Copyright (c) 2018 Agora. All rights reserved.
//
 
#import <Foundation/Foundation.h>
#import <AVFoundation/AVFoundation.h>
#import "AgoraEnumerates.h"
#import "AgoraObjects.h"
 
 
typedef NS_ENUM(NSUInteger, AgoraVideoPixelFormat) {
    AgoraVideoPixelFormatI420   = 1,
    AgoraVideoPixelFormatBGRA   = 2,
    AgoraVideoPixelFormatNV12   = 8,
};
 
typedef NS_ENUM(NSInteger, AgoraVideoRotation) {
    AgoraVideoRotationNone      = 0,
    AgoraVideoRotation90        = 90,
    AgoraVideoRotation180       = 180,
    AgoraVideoRotation270       = 270,
};
 
typedef NS_ENUM(NSInteger, AgoraVideoBufferType) {
    AgoraVideoBufferTypePixelBuffer = 1,
    AgoraVideoBufferTypeRawData     = 2,
};
 
@protocol AgoraVideoFrameConsumer <NSObject>
 
- (void)consumePixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer
             withTimestamp:(CMTime)timestamp
                  rotation:(AgoraVideoRotation)rotation NS_SWIFT_NAME(consumePixelBuffer(_:withTimestamp:rotation:));
 
- (void)consumeRawData:(void * _Nonnull)rawData
         withTimestamp:(CMTime)timestamp
                format:(AgoraVideoPixelFormat)format
                  size:(CGSize)size
              rotation:(AgoraVideoRotation)rotation NS_SWIFT_NAME(consumeRawData(_:withTimestamp:format:size:rotation:));
@end
 
@protocol AgoraVideoSourceProtocol <NSObject>
@required
@property (strong) id<AgoraVideoFrameConsumer> _Nullable consumer;
- (BOOL)shouldInitialize NS_SWIFT_NAME(shouldInitialize());
 
- (void)shouldStart NS_SWIFT_NAME(shouldStart());
 
- (void)shouldStop NS_SWIFT_NAME(shouldStop());
 
- (void)shouldDispose NS_SWIFT_NAME(shouldDispose());
 
- (AgoraVideoBufferType)bufferType NS_SWIFT_NAME(bufferType());
@end
 
@protocol AgoraVideoSinkProtocol <NSObject>
@required
- (BOOL)shouldInitialize NS_SWIFT_NAME(shouldInitialize());
 
- (void)shouldStart NS_SWIFT_NAME(shouldStart());
 
- (void)shouldStop NS_SWIFT_NAME(shouldStop());
 
- (void)shouldDispose NS_SWIFT_NAME(shouldDispose());
 
- (AgoraVideoBufferType)bufferType NS_SWIFT_NAME(bufferType());
 
- (AgoraVideoPixelFormat)pixelFormat NS_SWIFT_NAME(pixelFormat());
 
@optional
- (void)renderPixelBuffer:(CVPixelBufferRef _Nonnull)pixelBuffer
                 rotation:(AgoraVideoRotation)rotation NS_SWIFT_NAME(renderPixelBuffer(_:rotation:));
 
- (void)renderRawData:(void * _Nonnull)rawData
                 size:(CGSize)size
             rotation:(AgoraVideoRotation)rotation NS_SWIFT_NAME(renderRawData(_:size:rotation:));
@end
 
 
#pragma mark - Agora Default Media IO
 
typedef NS_ENUM(NSInteger, AgoraRtcDefaultCameraPosition) {
    AgoraRtcDefaultCameraPositionFront = 0,
    AgoraRtcDefaultCameraPositionBack = 1,
};
 
__attribute__((visibility("default"))) @interface AgoraRtcDefaultCamera: NSObject<AgoraVideoSourceProtocol>
#if TARGET_OS_IPHONE
@property (nonatomic, assign) AgoraRtcDefaultCameraPosition position;
- (instancetype _Nonnull)initWithPosition:(AgoraRtcDefaultCameraPosition)position NS_SWIFT_NAME(initWithPosition(_:));
#endif
@end
 
#if (!(TARGET_OS_IPHONE) && (TARGET_OS_MAC))
__attribute__((visibility("default"))) @interface AgoraRtcScreenCapture: NSObject<AgoraVideoSourceProtocol>
@property (nonatomic, readonly) NSUInteger windowId;
+ (instancetype _Nonnull)fullScreenCaptureWithFrequency:(NSInteger)captureFrequency
                                                bitRate:(NSInteger)bitRate NS_SWIFT_NAME(fullScreenCaptureWithFrequency(_:bitRate:));
+ (instancetype _Nonnull)windowCaptureWithId:(CGWindowID)windowId
                            captureFrequency:(NSInteger)captureFrequency
                                     bitRate:(NSInteger)bitRate
                                        rect:(CGRect)rect NS_SWIFT_NAME(windowCaptureWithId(_:captureFrequency:bitRate:rect:));
@end
#endif
 
__attribute__((visibility("default"))) @interface AgoraRtcDefaultRenderer: NSObject<AgoraVideoSinkProtocol>
@property (nonatomic, strong, readonly) VIEW_CLASS * _Nonnull view;
@property (nonatomic, assign) AgoraVideoRenderMode mode;
- (instancetype _Nonnull)initWithView:(VIEW_CLASS * _Nonnull)view
                           renderMode:(AgoraVideoRenderMode)mode NS_SWIFT_NAME(initWithView(_:renderMode:));
@end