KSYGPUBgpStreamerKit Class Reference
- - -Inherits from | -NSObject | -
---|---|
Declared in | -KSYGPUBgpStreamerKit.h | -
– initWithDefaultCfg
-
-
- 初始化方法
-- (instancetype)initWithDefaultCfg
Discussion
-创建带有默认参数的 kit,不会打断其他后台的音乐播放
Warning: kit只支持单实例推流,构造多个实例会出现异常
Declared In
-KSYGPUBgpStreamerKit.h
– initWithInterruptCfg
-
-
- 初始化方法
-- (instancetype)initWithInterruptCfg
Discussion
-创建带有默认参数的 kit,会打断其他后台的音乐播放
Warning: kit只支持单实例推流,构造多个实例会出现异常
Declared In
-KSYGPUBgpStreamerKit.h
– getKSYVersion
-
-
- 获取SDK版本号
-- (NSString *)getKSYVersion
Declared In
-KSYGPUBgpStreamerKit.h
filter
-
-
- 获取当前使用的滤镜
-@property (nonatomic, readonly) GPUImageOutput<GPUImageInput> *filter
Discussion
-通过此指针可以对滤镜参数进行设置 -@waning 请确保外部保留了filter的真实类型的指针, 否则会出现奔溃
-Declared In
-KSYGPUBgpStreamerKit.h
preview
-
-
- 预览视图
-@property (nonatomic, readonly) KSYGPUView *preview
Discussion
-通过此指针可以对预览视图进行操作
-Declared In
-KSYGPUBgpStreamerKit.h
gpuToStr
-
-
- 获取渲染的图像
-@property (nonatomic, readonly) KSYGPUPicOutput *gpuToStr
Discussion
-用于衔接GPU和streamer
-Declared In
-KSYGPUBgpStreamerKit.h
aCapDev
-
-
- 音频采集设备 Audio Unit 音频采集
-@property (nonatomic, readonly) KSYAUAudioCapture *aCapDev
Declared In
-KSYGPUBgpStreamerKit.h
aMixer
-
-
- 音频混合器
-@property (nonatomic, readonly) KSYAudioMixer *aMixer
Discussion
-用于将多路音频进行混合,将混合后的音频送入streamerBase
-Declared In
-KSYGPUBgpStreamerKit.h
msgStreamer
-
-
- 消息通道
-@property (nonatomic, readonly) KSYMessage *msgStreamer
Discussion
-用于采集消息,并将数据送入streamerBase
-Declared In
-KSYGPUBgpStreamerKit.h
streamerBase
-
-
- 获取初始化时创建的底层推流工具
-@property (nonatomic, readonly) KSYStreamerBase *streamerBase
Discussion
--
-
- 通过它来设置推流参数 -
-
-
- 通过它来启动,停止推流 -
Declared In
-KSYGPUBgpStreamerKit.h
maxAutoRetry
-
-
- 自动重连次数 关闭(0), 开启(>0), 默认为0
-@property (nonatomic, assign) int maxAutoRetry
Discussion
-当内部发现推流错误后, 会在一段时间后尝试重连 -自动重连不会重新获取推流地址, 仍然使用上次推流的地址
Warning: 如果在推流地址有过期时间, 请勿开启
Declared In
-KSYGPUBgpStreamerKit.h
autoRetryDelay
-
-
- 自动重连延时, 发现连接错误后, 重试的延时
-@property (nonatomic, assign) double autoRetryDelay
Discussion
-单位为秒, 默认为2s, 最小值为0.1s
-Declared In
-KSYGPUBgpStreamerKit.h
cameraLayer
-
-
- 摄像头图层
-@property (nonatomic, readonly) NSInteger cameraLayer
Declared In
-KSYGPUBgpStreamerKit.h
micTrack
-
-
- 麦克风通道
-@property (nonatomic, readonly) int micTrack
Declared In
-KSYGPUBgpStreamerKit.h
captureState
-
-
- 当前采集设备状况
-@property (nonatomic, readonly) KSYCaptureState captureState
Discussion
-可以通过该属性获取采集设备的工作状况
通知: -* KSYCaptureStateDidChangeNotification 当采集设备工作状态发生变化时提供通知 -* 收到通知后,通过本属性查询新的状态,并作出相应的动作
-Declared In
-KSYGPUBgpStreamerKit.h
– getCaptureStateName:
-
-
- 获取采集状态对应的字符串
-- (NSString *)getCaptureStateName:(KSYCaptureState)stat
Declared In
-KSYGPUBgpStreamerKit.h
– getCurCaptureStateName
-
-
- 获取当前采集状态对应的字符串
-- (NSString *)getCurCaptureStateName
Declared In
-KSYGPUBgpStreamerKit.h
– startPreview:
-
-
- 启动预览
-- (void)startPreview:(UIView *)view
Parameters
-view |
- 预览画面作为subview,插入到 view 的最底层 |
-
---|
Discussion
-设置完成采集参数之后,按照设置值启动预览,启动后对采集参数修改不会生效
需要访问摄像头和麦克风的权限,若授权失败,其他API都会拒绝服务
- -@warning: 开始推流前必须先启动预览
-See Also
--
-
-
videoDimension, cameraPosition, videoOrientation, @property videoFPS
-
-
Declared In
-KSYGPUBgpStreamerKit.h
– startVideoCap
-
-
- 开启视频配置和采集
-- (BOOL)startVideoCap
Discussion
-设置完成视频采集参数之后,按照设置值启动视频预览,启动后对视频采集参数修改不会生效
需要访问摄像头的权限,若授权失败,其他API都会拒绝服务
视频采集成功返回YES,不成功返回NO
-Declared In
-KSYGPUBgpStreamerKit.h
– startAudioCap
-
-
- 开始音频配置和采集
-- (BOOL)startAudioCap
Discussion
-设置完成音频采集参数之后,按照设置值启动音频预览,启动后对音频采集参数修改不会生效
需要访问麦克风的权限,若授权失败,其他API都会拒绝服务
音频采集成功返回YES,不成功返回NO
-Declared In
-KSYGPUBgpStreamerKit.h
– stopPreview
-
-
- 停止预览,停止采集设备,并清理会话
-- (void)stopPreview
Discussion
-若推流未结束,则先停止推流
-Declared In
-KSYGPUBgpStreamerKit.h
– appEnterBackground
-
-
- 进入后台: 暂停图像采集
-- (void)appEnterBackground
Discussion
-暂停图像采集和预览, 中断旁路录制
如果需要释放mic资源请直接调用停止采集
kit内部在收到UIApplicationDidEnterBackgroundNotification 或采集被打断等事件时,会主动调用本接口
-Declared In
-KSYGPUBgpStreamerKit.h
– appBecomeActive
-
-
- 回到前台: 恢复采集
-- (void)appBecomeActive
Discussion
-恢复图像采集和预览
恢复音频采集
kit内部在收到UIApplicationDidBecomeActiveNotification等事件时,会主动调用本接口
-Declared In
-KSYGPUBgpStreamerKit.h
previewDimension
-
-
- 预览分辨率 (仅在开始采集前设置有效)
-@property (nonatomic, assign) CGSize previewDimension
Discussion
-内部始终将较大的值作为宽度 (若需要竖屏,请设置 videoOrientation)
宽高都会向上取整为4的整数倍
有效范围: 宽度[160, 1920] 高度[ 90, 1080], 超出范围会取边界有效值
当预览分辨率与采集分辨率不一致时: -若宽高比不同, 先进行裁剪, 再进行缩放 -若宽高比相同, 直接进行缩放
默认值为(640, 360)
-Declared In
-KSYGPUBgpStreamerKit.h
streamDimension
-
-
- 用户定义的视频 推流 分辨率
-@property (nonatomic, assign) CGSize streamDimension
Discussion
-有效范围: 宽度[160, 1280] 高度[ 90, 720], 超出范围会取边界有效值
其他与previewDimension限定一致,
当与previewDimension不一致时, 同样先裁剪到相同宽高比, 再进行缩放
默认值为(640, 360)
-See Also
--
-
-
Declared In
-KSYGPUBgpStreamerKit.h
gpuOutputPixelFormat
-
-
- gpu output pixel format (默认:kCVPixelFormatType_32BGRA)
-@property (nonatomic, assign) OSType gpuOutputPixelFormat
Discussion
-目前支持 BGRA , NV12 和 I420
仅在开始推流前设置有效
-Declared In
-KSYGPUBgpStreamerKit.h
videoFPS
-
-
- 采集及编码视频帧率 (开始采集前设置有效)
-@property (nonatomic, assign) int videoFPS
Discussion
-video frame per seconds 有效范围[1~30], 超出范围会取边界有效值
默认值为15
-Declared In
-KSYGPUBgpStreamerKit.h
videoProcessingCallback
-
-
- 视频处理回调接口
-@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
Parameters
-sampleBuffer |
- 原始采集到的视频数据 |
-
---|
Discussion
-对sampleBuffer内的图像数据的修改将传递到观众端
请注意本函数的执行时间,如果太长可能导致不可预知的问题
请参考 CMSampleBufferRef
-Declared In
-KSYGPUBgpStreamerKit.h
audioProcessingCallback
-
-
- 音频处理回调接口
-@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
Discussion
-sampleBuffer 原始采集到的音频数据
对sampleBuffer内的pcm数据的修改将传递到观众端
请注意本函数的执行时间,如果太长可能导致不可预知的问题
请参考 CMSampleBufferRef
-Declared In
-KSYGPUBgpStreamerKit.h
– setupFilter:
-
-
-
-– processMessageData:
-
-
- 用户待发送的消息 -@param messageData待发送的消息
-- (BOOL)processMessageData:(NSDictionary *)messageData
Return Value
-YES / NO
-Declared In
-KSYGPUBgpStreamerKit.h
bgPic
-
-
- 背景图片,用于背景图片推流
-@property (nonatomic, readwrite) GPUImagePicture *bgPic
Discussion
-设置为nil为清除背景图片
-Declared In
-KSYGPUBgpStreamerKit.h
bgPicRotate
-
-
- 背景图片朝向
-@property (nonatomic, readwrite) GPUImageRotationMode bgPicRotate
Declared In
-KSYGPUBgpStreamerKit.h
+ getRotationMode:
-
-
- 读取图像的朝向
-+ (GPUImageRotationMode)getRotationMode:(UIImage *)img
Declared In
-KSYGPUBgpStreamerKit.h