diff --git a/demo/KSYLiveDemo/Info.plist b/demo/KSYLiveDemo/Info.plist index 38b07d5..eb0e046 100644 --- a/demo/KSYLiveDemo/Info.plist +++ b/demo/KSYLiveDemo/Info.plist @@ -15,11 +15,11 @@ CFBundlePackageType APPL CFBundleShortVersionString - 2.7.1 + 2.8.0 CFBundleSignature ???? CFBundleVersion - 2.7.1.1 + 2.8.0.1 LSRequiresIPhoneOS NSAppTransportSecurity diff --git a/demo/KSYLiveDemo/KSYDemoUI/KSYFilterView.m b/demo/KSYLiveDemo/KSYDemoUI/KSYFilterView.m index 60f9976..f2e5b61 100644 --- a/demo/KSYLiveDemo/KSYDemoUI/KSYFilterView.m +++ b/demo/KSYLiveDemo/KSYDemoUI/KSYFilterView.m @@ -37,7 +37,7 @@ @implementation KSYFilterView - (id)init{ self = [super init]; - _effectNames = [NSArray arrayWithObjects: @"1 小清新", @"2 靓丽", + _effectNames = [NSArray arrayWithObjects: @"0 原图", @"1 小清新", @"2 靓丽", @"3 甜美可人", @"4 怀旧", @"5 蓝调", @"6 老照片" , @"7 樱花", @"8 樱花（光线较暗）", @"9 红润（光线较暗）", @"10 阳光（光线较暗）", @"11 红润", @"12 阳光", @"13 自然", nil]; @@ -110,6 +110,7 @@ - (id)init{ _effectPicker.dataSource = self; _effectPicker.showsSelectionIndicator= YES; _effectPicker.backgroundColor = [UIColor colorWithWhite:0.8 alpha:0.3]; + [_effectPicker selectRow:1 inComponent:0 animated:YES]; return self; } - (void)layoutUI{ @@ -324,18 +325,19 @@ - (NSString *)pickerView:(UIPickerView *)pickerView - (void)pickerView:(UIPickerView *)pickerView didSelectRow:(NSInteger)row inComponent:(NSInteger)component { - _curEffectIdx = row+1; + _curEffectIdx = row; if ( [_curFilter isMemberOfClass:[GPUImageFilterGroup class]]){ GPUImageFilterGroup * fg = (GPUImageFilterGroup *)_curFilter; KSYBuildInSpecialEffects * sf = (KSYBuildInSpecialEffects *)[fg filterAtIndex:1]; UIImage *downloadImage = [self getGPUResourceImageAt:_effectResourceNames[_curEffectIdx]]; - if (downloadImage) { - [sf setSpecialEffectsUIImage:downloadImage]; - } + [sf setSpecialEffectsUIImage:downloadImage]; } } -(UIImage *)getGPUResourceImageAt:(NSString *)effectName{ + if ([effectName isEqualToString:@"null"]){ + return nil; + } NSString * path = [[NSBundle mainBundle] pathForResource:@"KSYGPUResource" ofType:@"bundle"]; path = [path stringByAppendingPathComponent:effectName]; if ([UIImage imageWithContentsOfFile:path]) { diff --git a/demo/KSYLiveDemo/KSYDemoUI/KSYPresetCfgView.m b/demo/KSYLiveDemo/KSYDemoUI/KSYPresetCfgView.m index f0f91f1..651bbf6 100644 --- a/demo/KSYLiveDemo/KSYDemoUI/KSYPresetCfgView.m +++ b/demo/KSYLiveDemo/KSYDemoUI/KSYPresetCfgView.m @@ -69,7 +69,7 @@ - (id) init { _frameRateUI = [self addSliderName:@"视频帧率fps" From:1.0 To:30.0 Init:15.0]; _lblVideoCodecUI = [self addLable:@"视频编码器"]; - _videoCodecUI = [self addSegCtrlWithItems:@[@"自动",@"软264",@"硬264",@"软265"]]; + _videoCodecUI = [self addSegCtrlWithItems:@[@"自动",@"软264",@"硬264",@"软265", @"硬265"]]; _lblAudioCodecUI = [self addLable:@"音频编码器"]; _audioCodecUI = [self addSegCtrlWithItems:@[@"aache",@"aaclc",@"ATaaclc", @"aachev2"]]; _videoKbpsUI = [self addSliderName:@"视频码率kbps" From:100.0 To:1600.0 Init:800.0]; @@ -473,6 +473,8 @@ - (KSYVideoCodec) videoCodec { return KSYVideoCodec_VT264; case 3: return KSYVideoCodec_QY265; + case 4: + return KSYVideoCodec_VT265; default: return KSYVideoCodec_AUTO; } diff --git a/demo/export.plist b/demo/export.plist new file mode 100644 index 0000000..a89fc21 --- /dev/null +++ b/demo/export.plist @@ -0,0 +1,15 @@ + + + + + provisioningProfiles + + com.ksyun.ios.KSYLiveDemo + KSYLiveDemoEnterprise_Dis_2017.9.26 + + teamID + 36PUU93BJ2 + method + enterprise + + diff --git a/doc/docset-installed.txt b/doc/docset-installed.txt index dafe10f..07618af 100644 --- a/doc/docset-installed.txt +++ b/doc/docset-installed.txt @@ -1,4 +1,4 @@ Documentation set was installed to Xcode! -Path: /Users/ksyci/Library/Developer/Shared/Documentation/DocSets/com.ksyun.KSYLive_iOS.docset -Time: 2017-09-21 09:51:33 +0000 \ No newline at end of file +Path: /Users/ksvc/Library/Developer/Shared/Documentation/DocSets/com.ksyun.KSYLive_iOS.docset +Time: 2017-09-28 10:50:33 +0000 \ No newline at end of file diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachability.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachability.html index 7f0aac1..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachability.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachability.html @@ -3,11 +3,11 @@ - KSYNetworkReachability Block Reference + - +
@@ -59,35 +59,15 @@

-

KSYNetworkReachability Block Reference

+

-
- - - - -
Declared inKSYReachability.h
- - - - -

Block Definition

-

KSYNetworkReachability

- - -typedef void (^KSYNetworkReachability) (KSYReachability *reachability, SCNetworkConnectionFlags flags) - - - - -
@@ -96,8 +76,6 @@

KSYNetworkReachability

Copyright © 2017 Kingsoft. All rights reserved.

-

Generated by appledoc 2.2.1 (build 1334).

-
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachable.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachable.html index 3dadbe9..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachable.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkReachable.html @@ -3,11 +3,11 @@ - KSYNetworkReachable Block Reference + - +
@@ -59,35 +59,15 @@

-

KSYNetworkReachable Block Reference

+

-
- - - - -
Declared inKSYReachability.h
- - - - -

Block Definition

-

KSYNetworkReachable

- - -typedef void (^KSYNetworkReachable) (KSYReachability *reachability) - - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkUnreachable.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkUnreachable.html index 3bbf78c..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkUnreachable.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYNetworkUnreachable.html @@ -3,11 +3,11 @@ - KSYNetworkUnreachable Block Reference + - +
@@ -59,35 +59,15 @@

-

KSYNetworkUnreachable Block Reference

+

-
- - - - -
Declared inKSYReachability.h
- - - - -

Block Definition

-

KSYNetworkUnreachable

- - -typedef void (^KSYNetworkUnreachable) (KSYReachability *reachability) - - - - -
@@ -96,8 +76,6 @@

KSYNetworkUnreachable

Copyright © 2017 Kingsoft. All rights reserved.

-

Generated by appledoc 2.2.1 (build 1334).

-
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyAudioDataBlock.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyAudioDataBlock.html index 2c147c8..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyAudioDataBlock.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyAudioDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyAudioDataBlock Block Reference + - +
@@ -59,54 +59,15 @@

-

KSYPlyAudioDataBlock Block Reference

+

-
- - - - -
Declared inKSYMoviePlayerController.h
- - - - -

Block Definition

-

KSYPlyAudioDataBlock

- - -
-

音频数据回调

-
- - - -typedef void (^KSYPlyAudioDataBlock) (CMSampleBufferRef sampleBuffer) - - - - - - - - - - - -
-

Declared In

- KSYMoviePlayerController.h
-
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyMessageDataBlock.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyMessageDataBlock.html index 5bf86be..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyMessageDataBlock.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyMessageDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyMessageDataBlock Block Reference + - +
@@ -59,54 +59,15 @@

-

KSYPlyMessageDataBlock Block Reference

+

-
- - - - -
Declared inKSYMoviePlayerController.h
- - - - -

Block Definition

-

KSYPlyMessageDataBlock

- - -
-

message数据回调

-
- - - -typedef void (^KSYPlyMessageDataBlock) (NSDictionary *message, int64_t pts, int64_t param) - - - - - - - - - - - -
-

Declared In

- KSYMoviePlayerController.h
-
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyTextureBlock.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyTextureBlock.html index 0b31220..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyTextureBlock.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyTextureBlock.html @@ -3,11 +3,11 @@ - KSYPlyTextureBlock Block Reference + - +
@@ -59,54 +59,15 @@

-

KSYPlyTextureBlock Block Reference

+

-
- - - - -
Declared inKSYMoviePlayerController.h
- - - - -

Block Definition

-

KSYPlyTextureBlock

- - -
-

texture回调

-
- - - -typedef void (^KSYPlyTextureBlock) (GLuint texId, int width, int height, double pts) - - - - - - - - - - - -
-

Declared In

- KSYMoviePlayerController.h
-
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyVideoDataBlock.html b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyVideoDataBlock.html index 4d2c168..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyVideoDataBlock.html +++ b/doc/docset/Contents/Resources/Documents/Blocks/KSYPlyVideoDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyVideoDataBlock Block Reference + - +
@@ -59,54 +59,15 @@

-

KSYPlyVideoDataBlock Block Reference

+

-
- - - - -
Declared inKSYMoviePlayerController.h
- - - - -

Block Definition

-

KSYPlyVideoDataBlock

- - -
-

视频数据回调

-
- - - -typedef void (^KSYPlyVideoDataBlock) (CMSampleBufferRef pixelBuffer) - - - - - - - - - - - -
-

Declared In

- KSYMoviePlayerController.h
-
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Categories/AVAudioSession+KSY.html b/doc/docset/Contents/Resources/Documents/Categories/AVAudioSession+KSY.html index 7bc32d2..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Categories/AVAudioSession+KSY.html +++ b/doc/docset/Contents/Resources/Documents/Categories/AVAudioSession+KSY.html @@ -3,11 +3,11 @@ - AVAudioSession(KSY) Category Reference + - +
@@ -43,54 +43,10 @@

@@ -103,521 +59,15 @@

-

AVAudioSession(KSY) Category Reference

+

-
- - - - -
Declared inAVAudioSession+KSY.h
- - -
- -

Overview

-

iOS的AVAudioSession 属性配置工具类

- -
    -
  1. 主要是保证推流时有采集和播放音频的权限 AVAudioSessionCategoryPlayAndRecord
    2. -
  2. 将一些常用的AVAudioSession的配置项提取为属性, 方便设置
    3. -
  3. 提供查询和修改当前音频采集设备相关的工具函数 比如查询是否有耳机
    4. -
- -
- - - -
- - - - - - -
-
- -

– setDefaultCfg -

- -
-
- -
- - -
-

设置默认配置

-
- - - -
- (void)setDefaultCfg
- - - - - - - - - -
-

Discussion

-

bInterruptOtherAudio : NO

bDefaultToSpeaker : YES

bAllowBluetooth : YES

AVAudioSessionCategory : AVAudioSessionCategoryPlayAndRecord

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

  bInterruptOtherAudio -

- -
-
- -
- - -
-

是否打断其他后台的音乐播放 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL bInterruptOtherAudio
- - - - - - - - - -
-

Discussion

-

也可以理解为是否允许在其他后台音乐播放的同时进行采集

YES:开始采集时，会打断其他的后台播放音乐，也会被其他音乐打断（采集过程中，启动其他音乐播放，音频采集被中止）

NO: 可以与其他后台播放共存，相互之间不会被打断

参考 AVAudioSessionCategoryOptionMixWithOthers

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

  bDefaultToSpeaker -

- -
-
- -
- - -
-

启动采集后,是否从扬声器播放声音 (默认为YES)

-
- - - -
@property (nonatomic, assign) BOOL bDefaultToSpeaker
- - - - - - - - - -
-

Discussion

-

启动声音采集后,iOS系统的行为是默认从听筒播放声音的

将该属性设为YES, 则改为默认从扬声器播放

参考 AVAudioSessionCategoryOptionDefaultToSpeaker

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

  bAllowBluetooth -

- -
-
- -
- - -
-

是否启用蓝牙设备 (默认为YES)

-
- - - -
@property (nonatomic, assign) BOOL bAllowBluetooth
- - - - - - - - - -
-

Discussion

-

参考 AVAudioSessionCategoryOptionAllowBluetooth

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

  AVAudioSessionCategory -

- -
-
- -
- - -
-

本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord)

-
- - - -
@property (nonatomic, assign) NSString *AVAudioSessionCategory
- - - - - - - - - -
-

Discussion

-

用于指定推流过程中需要采集和播放音频的权限

Warning: 如无必要请勿修改

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

+ isBluetoothInputAvaible -

- -
-
- -
- - -
-

是否有蓝牙麦克风可用

-
- - - -
+ (BOOL)isBluetoothInputAvaible
- - - - - -
-

Return Value

-

是/否有蓝牙麦克风可用

-
- - - - - - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

+ switchBluetoothInput: -

- -
-
- -
- - -
-

选择是否使用蓝牙麦克风

-
- - - -
+ (BOOL)switchBluetoothInput:(BOOL)onOrOff
- - - -
-

Parameters

- - - - - - - -
onOrOff

: YES 使用蓝牙麦克风 NO

-
- - - -
-

Return Value

-

是/否有蓝牙麦克风可用

-
- - - - - - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

+ isHeadsetInputAvaible -

- -
-
- -
- - -
-

是否有耳机麦克风可用

-
- - - -
+ (BOOL)isHeadsetInputAvaible
- - - - - -
-

Return Value

-

是/否有耳机麦克风

-
- - - - - - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

+ isHeadsetPluggedIn -

- -
-
- -
- - -
-

查询当前是否有耳机(包括蓝牙耳机)

-
- - - -
+ (BOOL)isHeadsetPluggedIn
- - - - - - - - - - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
- -

  currentMicType -

- -
-
- -
- - -
-

当前使用的音频采集设备

-
- - - -
@property KSYMicType currentMicType
- - - - - - - - - -
-

Discussion

-

当设置新值时, 如果修改成功, 重新查询为新值, 修改不成功值不变

参考 KSYMicType

-
- - - - - - - -
-

Declared In

-

AVAudioSession+KSY.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAQPlayer.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAQPlayer.html index 56167bf..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAQPlayer.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAQPlayer.html @@ -3,11 +3,11 @@ - KSYAQPlayer Class Reference + - +
@@ -43,60 +43,10 @@

@@ -109,738 +59,15 @@

-

KSYAQPlayer Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAQPlayer.h
- - -
- -

Overview

-

基于AudioQueue的音乐播放器

- -
* 提供声音播放的功能
-* 通过回调拉取新的数据
-* 提供音量和音调调节功能
-* 能将播放后的音频数据通过回调送出 (回调的数据为音效处理之后的数据)
-
-
- - - - - -
- - - - - - -
-
- -

– play: -

- -
-
- -
- - -
-

开始播放

-
- - - -
- (BOOL)play:(AudioStreamBasicDescription *)fmt
- - - -
-

Parameters

- - - - - - - -
fmt,

后续送入的音频数据的格式

-
- - - -
-

Return Value

-

是否能够开始播放

-
- - - - - - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

– stop -

- -
-
- -
- - -
-

停止播放背景音乐

-
- - - -
- (void)stop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

– pause -

- -
-
- -
- - -
-

暂停播放背景音乐

-
- - - -
- (void)pause
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

– resume -

- -
-
- -
- - -
-

恢复播放背景音乐

-
- - - -
- (void)resume
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  volume -

- -
-
- -
- - -
-

播放音量

-
- - - -
@property (nonatomic, assign) double volume
- - - - - - - - - -
-

Discussion

-

调整范围 0.0~1.0, 默认为1

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  pitch -

- -
-
- -
- - -
-

播放声音的音调

-
- - - -
@property (nonatomic, assign) double pitch
- - - - - - - - - -
-

Discussion

-

调整范围 [-24.0 ~ 24.0], 默认为0.01, 单位为半音

0.01 为1度, 1.0为一个半音, 12个半音为1个八度

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  playRate -

- -
-
- -
- - -
-

播放速度

-
- - - -
@property (nonatomic, assign) double playRate
- - - - - - - - - -
-

Discussion

-

调整范围 0.5~2.0, 默认为1

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  inFmt -

- -
-
- -
- - -
-

输入的音频格式

-
- - - -
@property (nonatomic, readonly) AudioStreamBasicDescription inFmt
- - - - - - - - - -
-

Discussion

-

每次输入音频格式可能变化时,请重新调用play: 方法

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  outFmt -

- -
-
- -
- - -
-

回调输出的音频格式

-
- - - -
@property (nonatomic, readonly) AudioStreamBasicDescription outFmt
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  mute -

- -
-
- -
- - -
-

背景音乐播放静音

-
- - - -
@property (nonatomic, assign) BOOL mute
- - - - - - - - - -
-

Discussion

-

仅仅静音播放, 不影响回调的音频数据

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  pullDataCB -

- -
-
- -
- - -
-

音频数据输入回调

-
- - - -
@property (nonatomic, copy) BOOL ( ^ ) ( AudioQueueBufferRef buf ) pullDataCB
- - - - - - - - - -
-

Discussion

-

buf 送入的音频数据

-
- - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  putDataCB -

- -
-
- -
- - -
-

音频数据输出回调

-
- - - -
@property (nonatomic, copy) BOOL ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime pts ) putDataCB
- - - - - - - - - -
-

Discussion

-

pData 回调输出的数据指针

len sample数

fmt 数据的格式

pts 目前没有时间戳输出

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  isRunning -

- -
-
- -
- - -
-

音频播放是否运行

-
- - - -
@property (nonatomic, readonly) BOOL isRunning
- - - - - - - - - -
-

Discussion

-

音频是否输出到speaker播放

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  isPaused -

- -
-
- -
- - -
-

音频播放是否暂停

-
- - - -
@property (nonatomic, readonly) BOOL isPaused
- - - - - - - - - -
-

Discussion

-

通过 pause/resume 改变状态

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
- -

  audioErrorCode -

- -
-
- -
- - -
-

播放错误码

-
- - - -
@property (nonatomic, readonly) OSStatus audioErrorCode
- - - - - - - - - -
-

Discussion

-

播放错误码具体内容可以参考AudioQueue的Apple文档。

-
- - - - - - - -
-

Declared In

-

KSYAQPlayer.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAUAudioCapture.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAUAudioCapture.html index c1003e7..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAUAudioCapture.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAUAudioCapture.html @@ -3,11 +3,11 @@ - KSYAUAudioCapture Class Reference + - +
@@ -43,72 +43,10 @@

@@ -121,940 +59,23 @@

-

KSYAUAudioCapture Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAUAudioCapture.h
- - -
- -

Overview

-

音频采集模块

-
    -
  1. 基于 AudioUnit 实现的低延时音频采集模块
    2. -
  2. 支持对采集的语音添加混响音效 (目前提供了4种类型的混响场景)
    3. -
  3. 支持将采集的声音低延时播放,帮助主播选择音效 (又称"耳返")
    4. -
  4. 支持对采集的音频进行降噪处理
    5. -
  5. 采集的声音通过回调函数提供出来
    6. -
  6. 当启用噪声抑制功能时,输出音频数据的采样率为16K(重采样得到,与采集的采样率无关)
    7. -
- -
- - - -
- - + +
- - - -
-
- -

– initWithSampleRate: -

- -
-
- -
- - -
-

指定采集音频的采样率

-
- - - -
- (id)initWithSampleRate:(double)sampleRate
- - - -
-

Parameters

- - - - - - - -
sampleRate

指定的采样率 , 默认为44100Hz

-
- - - -
-

Return Value

-

采集设备实例

-
- - - - - -
-

Discussion

-

Warning: 请尽量使用默认的44100, 使用其他的采样率可能导致混响和变声等功能异常

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

– startCapture -

- -
-
- -
- - -
-

启动音频采集, 占据麦克风资源

-
- - - -
- (BOOL)startCapture
- - - - - -
-

Return Value

-

是否启动采集成功

-
- - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

– stopCapture -

- -
-
- -
- - -
-

停止音频采集, 释放麦克风资源

-
- - - -
- (void)stopCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

– pauseCapture -

- -
-
- -
- - -
-

暂停音频采集(仍然占用麦克风资源) 停止回调音频数据

-
- - - -
- (BOOL)pauseCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

– pauseWithMuteData -

- -
-
- -
- - -
-

暂停音频采集(仍然占用麦克风资源), 回调静音音频数据

-
- - - -
- (BOOL)pauseWithMuteData
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

– resumeCapture -

- -
-
- -
- - -
-

恢复正常音频采集和回调

-
- - - -
- (BOOL)resumeCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  bPlayCapturedAudio -

- -
-
- -
- - -
-

是否播放采集的声音 (又称"耳返")

-
- - - -
@property (nonatomic, assign) BOOL bPlayCapturedAudio
- - - - - - - - - -
-

Discussion

-

Warning: 如果在没有插入耳机的情况下启动, 容易出现很刺耳的声音

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  enableVoiceProcess -

- -
-
- -
- - -
-

是否使用带回声消除的采集模块(默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL enableVoiceProcess
- - - - - - - - - -
-

Discussion

-

请在连麦开始时在设置此属性为YES, 连麦结束记得设置为NO

此属性为YES时, 启动采集一定会打断其他音乐播放

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  noiseSuppressionLevel -

- -
-
- -
- - -
-

噪声抑制处理的等级(默认为KSYAudioNoiseSuppress_OFF)

-
- - - -
@property (nonatomic, assign) KSYAudioNoiseSuppress noiseSuppressionLevel
- - - - - - - - - -
-

Discussion

-

当启用噪声抑制处理后, 内部会进行输出音频数据的

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  bForceAudioSessionCatogary -

- -
-
- -
- - -
-

是否强制设置AVAudioSession的类别为PlayAndRecord(默认为YES)

-
- - - -
@property (nonatomic, assign) BOOL bForceAudioSessionCatogary
- - - - - - - - - -
-

Discussion

-

此属性为YES时, 每次启动采集会将类别强制设置为AVAudioSessionCategoryPlayAndRecord

为了避免别APP中的其他SDK将AVAudioSession的类别修改为无法录音,导致无法采集到声音

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  micVolume -

- -
-
- -
- - -
-

设置mic采集的声音音量

-
- - - -
@property (nonatomic, assign) Float32 micVolume
- - - - - - - - - -
-

Discussion

-

调整范围 0.0~1.0

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  outputPts -

- -
-
- -
- - -
-

最近一次输出的音频包的时间戳

-
- - - -
@property (nonatomic, readonly) CMTime outputPts
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  reverbType -

- -
-
- -
- - -
-

混响类型

-
- - - -
@property (nonatomic, assign) int reverbType
- - - - - - - - - -
-

Discussion

-

目前提供了4种类型的混响场景, type和场景的对应关系如下

- -
    -
  • 0 关闭
    • -
  • 1 录音棚
    • -
  • 2 ktv
    • -
  • 3 小舞台
    • -
  • 4 演唱会
    • -
- -
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  effectType -

- -
-
- -
- - -
-

音效类型

-
- - - -
@property (nonatomic, assign) KSYAudioEffectType effectType
- - - - - - - - - -
-

Discussion

-

音效类型仅在enableVoiceProcess=NO时有效

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

采集数据输出回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 为采集到的音频数据

与pcmProcessingCallback两者只能二选一, 设置 audioProcessingCallback 会清空pcmProcessingCallback

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  pcmProcessingCallback -

- -
-
- -
- - -
-

采集数据输出回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime timeInfo ) pcmProcessingCallback
- - - - - - - - - -
-

Discussion

-

pData 和 len 为采集数据和长度 (目前只支持单声道, 只有pData[0]为有效数据指针 )

与audioProcessingCallback两者只能二选一, 设置 pcmProcessingCallback 会清空audioProcessingCallback

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  customPlayCallback -

- -
-
- -
- - -
-

用户可以自定义播放的内容，直接把数据填入ioData

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( AudioBufferList *ioData , UInt32 inumber ) customPlayCallback
- - - - - - - - - -
-

Discussion

-

ioData 目前只支持int16 的单声道数据

-
- - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

+ isHeadsetPluggedIn -

- -
-
- -
- - -
-

是否有耳机麦克风可用

-
- - - -
+ (BOOL)isHeadsetPluggedIn
- - - - - -
-

Return Value

-

是/否有耳机麦克风

-
- - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
- -

  isRunning -

- -
-
- -
- - -
-

设备是否正在采集音频数据

-
- - - -
@property (nonatomic, readonly) BOOL isRunning
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAUAudioCapture.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAVAudioSession.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAVAudioSession.html index 1424209..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAVAudioSession.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAVAudioSession.html @@ -3,11 +3,11 @@ - KSYAVAudioSession Class Reference + - +
@@ -43,56 +43,10 @@

@@ -105,570 +59,15 @@

-

KSYAVAudioSession Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAVAudioSession.h
- - -
- -

Overview

-

iOS的AVAudioSession 属性配置工具类

- -
    -
  1. 主要是保证推流时有采集和播放音频的权限 AVAudioSessionCategoryPlayAndRecord
    2. -
  2. 将一些常用的AVAudioSession的配置项提取为属性, 方便设置
    3. -
  3. 提供查询和修改当前音频采集设备相关的工具函数 比如查询是否有耳机
    4. -
- -
- - - - - -
- - - - - - -
-
- -

  bInterruptOtherAudio -

- -
-
- -
- - -
-

是否打断其他后台的音乐播放 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL bInterruptOtherAudio
- - - - - - - - - -
-

Discussion

-

也可以理解为是否允许在其他后台音乐播放的同时进行采集

YES:开始采集时，会打断其他的后台播放音乐，也会被其他音乐打断（采集过程中，启动其他音乐播放，音频采集被中止）

NO: 可以与其他后台播放共存，相互之间不会被打断

参考 AVAudioSessionCategoryOptionMixWithOthers

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

  bDefaultToSpeaker -

- -
-
- -
- - -
-

启动采集后,是否从扬声器播放声音 (默认为YES)

-
- - - -
@property (nonatomic, assign) BOOL bDefaultToSpeaker
- - - - - - - - - -
-

Discussion

-

启动声音采集后,iOS系统的行为是默认从听筒播放声音的

将该属性设为YES, 则改为默认从扬声器播放

参考 AVAudioSessionCategoryOptionDefaultToSpeaker

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

  bAllowBluetooth -

- -
-
- -
- - -
-

是否启用蓝牙设备 (默认为YES)

-
- - - -
@property (nonatomic, assign) BOOL bAllowBluetooth
- - - - - - - - - -
-

Discussion

-

参考 AVAudioSessionCategoryOptionAllowBluetooth

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

– setAVAudioSessionOption -

- -
-
- -
- - -
-

设置声音采集需要的AUAudioSession的参数

-
- - - -
- (void)setAVAudioSessionOption
- - - - - - - - - -
-

Discussion

-

按照属性的设置值刷新AUAudioSession的配置

参考 AUAudioSession

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

  AVAudioSessionCategory -

- -
-
- -
- - -
-

本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord)

-
- - - -
@property (nonatomic, assign) NSString *AVAudioSessionCategory
- - - - - - - - - -
-

Discussion

-

用于指定推流过程中需要采集和播放音频的权限

Warning: 如无必要请勿修改

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

– checkCategory -

- -
-
-
- - -
-

检查当前AVAudioSession的类别是否与设置的AVAudioSessionCategory 一致

-
- - - -
- (BOOL)checkCategory
- - - - - - - - - -
-

Discussion

-

AVAudioSession为公有的单例, APP中的其他SDK也可以修改

因此可能出现直播时,改为无录音权限的类别的情况, 通过此方法进行检查

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

+ isBluetoothInputAvaible -

- -
-
- -
- - -
-

是否有蓝牙麦克风可用

-
- - - -
+ (BOOL)isBluetoothInputAvaible
- - - - - -
-

Return Value

-

是/否有蓝牙麦克风可用

-
- - - - - - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

+ switchBluetoothInput: -

- -
-
- -
- - -
-

选择是否使用蓝牙麦克风

-
- - - -
+ (BOOL)switchBluetoothInput:(BOOL)onOrOff
- - - -
-

Parameters

- - - - - - - -
onOrOff

: YES 使用蓝牙麦克风 NO

-
- - - -
-

Return Value

-

是/否有蓝牙麦克风可用

-
- - - - - - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

+ isHeadsetInputAvaible -

- -
-
- -
- - -
-

是否有耳机麦克风可用

-
- - - -
+ (BOOL)isHeadsetInputAvaible
- - - - - -
-

Return Value

-

是/否有耳机麦克风

-
- - - - - - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

+ isHeadsetPluggedIn -

- -
-
- -
- - -
-

查询当前是否有耳机(包括蓝牙耳机)

-
- - - -
+ (BOOL)isHeadsetPluggedIn
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
- -

  currentMicType -

- -
-
- -
- - -
-

当前使用的音频采集设备

-
- - - -
@property KSYMicType currentMicType
- - - - - - - - - -
-

Discussion

-

当设置新值时, 如果修改成功, 重新查询为新值, 修改不成功值不变

参考 KSYMicType

-
- - - - - - - -
-

Declared In

-

KSYAVAudioSession.h

-
- - -
-
-
-
- -
- - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAVFCapture.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAVFCapture.html index d64a274..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAVFCapture.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAVFCapture.html @@ -3,11 +3,11 @@ - KSYAVFCapture Class Reference + - +
@@ -43,96 +43,10 @@

@@ -145,1449 +59,23 @@

-

KSYAVFCapture Class Reference

+

-
- - - - - - - - - - -
Inherits fromNSObject
Conforms toAVCaptureAudioDataOutputSampleBufferDelegate
AVCaptureVideoDataOutputSampleBufferDelegate
Declared inKSYAVFCapture.h
- - -
- -

Overview

-

基于 AVFoundation的 音视频采集模块

-
    -
  • 通过回调将采集的音频和视频数据传出
    • -
  • 将摄像头和音频的常用操作进行封装
    • -
  • 注意: 使用AVFoundation的音频采集时,可能无法进行后台采集
    • -
- -
- - - -
- - + +
- -

Other Methods

- -
-
- -

  isRunning -

- -
-
- -
- - -
-

Whether or not the underlying AVCaptureSession is running

-
- - - -
@property (readonly, nonatomic) BOOL isRunning
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  captureSession -

- -
-
- -
- - -
-

The AVCaptureSession used to capture from the camera

-
- - - -
@property (readonly, retain, nonatomic) AVCaptureSession *captureSession
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  captureSessionPreset -

- -
-
- -
- - -
-

This enables the capture session preset to be changed on the fly

-
- - - -
@property (readwrite, nonatomic, copy) NSString *captureSessionPreset
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  frameRate -

- -
-
- -
- - -
-

采集帧率 有效范围为 0~30

-
- - - -
@property (readwrite) int32_t frameRate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  outputPixelFmt -

- -
-
- -
- - -
-

输出图像的像素格式 有效值 为 NV12 和BGRA - - kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange - - kCVPixelFormatType_420YpCbCr8BiPlanarFullRange - - kCVPixelFormatType_32BGRA

-
- - - -
@property (readwrite) OSType outputPixelFmt
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  frontFacingCameraPresent -

- -
-
- -
- - -
-

Easy way to tell which cameras are present on device

-
- - - -
@property (readonly, getter=isFrontFacingCameraPresent) BOOL frontFacingCameraPresent
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  backFacingCameraPresent -

- -
-
- -
- - -
-

Easy way to tell which cameras are present on device

-
- - - -
@property (readonly, getter=isBackFacingCameraPresent) BOOL backFacingCameraPresent
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  inputCamera -

- -
-
- -
- - -
-

Use this property to manage camera settings. Focus point, exposure point, etc.

-
- - - -
@property (readonly) AVCaptureDevice *inputCamera
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  outputImageOrientation -

- -
-
- -
- - -
-

This determines the rotation applied to the output image, based on the source material

-
- - - -
@property (readwrite, nonatomic) UIInterfaceOrientation outputImageOrientation
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  bMirrorRearCamera -

- -
-
- -
- - -
-

These properties determine whether or not the two camera orientations should be mirrored. By default, (YES, NO).

-
- - - -
@property (readwrite, nonatomic) BOOL bMirrorFrontCamera , bMirrorRearCamera
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

+ isBackFacingCameraPresent -

- -
-
- -
- - -
-

后置摄像头是否存在

-
- - - -
+ (BOOL)isBackFacingCameraPresent
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

+ isFrontFacingCameraPresent -

- -
-
- -
- - -
-

前置摄像头是否存在

-
- - - -
+ (BOOL)isFrontFacingCameraPresent
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

+ uiOrientationToAVOrientation: -

- -
-
- -
- - -
-

UIInterfaceOrientation 转为 AVCaptureVideoOrientation

-
- - - -
+ (AVCaptureVideoOrientation)uiOrientationToAVOrientation:(UIInterfaceOrientation)orien
- - - -
-

Parameters

- - - - - - - -
orien

UI 的朝向,比如状态栏相对Home键的位置

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
-
- - - -

Initialization and teardown

- -
-
- -

– initWithSessionPreset:cameraPosition: -

- -
-
- -
- - -
-

Begin a capture session

-
- - - -
- (id)initWithSessionPreset:(NSString *)sessionPreset cameraPosition:(AVCaptureDevicePosition)cameraPosition
- - - -
-

Parameters

- - - - - - - - - - - - -
sessionPreset

Session preset to use

cameraPosition

Camera to capture from

-
- - - - - - - -
-

Discussion

-

See AVCaptureSession for acceptable values

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– addAudioInputsAndOutputs -

- -
-
- -
- - -
-

Add audio capture to the session. Adding inputs and outputs freezes the capture session momentarily, so you - can use this method to add the audio inputs and outputs early, if you’re going to set the audioEncodingTarget - later. Returns YES is the audio inputs and outputs were added, or NO if they had already been added.

-
- - - -
- (BOOL)addAudioInputsAndOutputs
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– removeAudioInputsAndOutputs -

- -
-
- -
- - -
-

Remove the audio capture inputs and outputs from this session. Returns YES if the audio inputs and outputs - were removed, or NO is they hadn’t already been added.

-
- - - -
- (BOOL)removeAudioInputsAndOutputs
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– removeInputsAndOutputs -

- -
-
- -
- - -
-

Tear down the capture session

-
- - - -
- (void)removeInputsAndOutputs
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
-
- - - -

Manage the camera video stream

- -
-
- -

– startCameraCapture -

- -
-
- -
- - -
-

Start camera capturing

-
- - - -
- (void)startCameraCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– stopCameraCapture -

- -
-
- -
- - -
-

Stop camera capturing

-
- - - -
- (void)stopCameraCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– pauseCameraCapture -

- -
-
- -
- - -
-

Pause camera capturing

-
- - - -
- (void)pauseCameraCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– resumeCameraCapture -

- -
-
- -
- - -
-

Resume camera capturing

-
- - - -
- (void)resumeCameraCapture
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– cameraPosition -

- -
-
- -
- - -
-

Get the position (front, rear) of the source camera

-
- - - -
- (AVCaptureDevicePosition)cameraPosition
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– videoCaptureConnection -

- -
-
- -
- - -
-

Get the AVCaptureConnection of the source camera

-
- - - -
- (AVCaptureConnection *)videoCaptureConnection
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– rotateCamera -

- -
-
- -
- - -
-

This flips between the front and rear cameras

-
- - - -
- (void)rotateCamera
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– captureDimension -

- -
-
- -
- - -
-

查询实际的采集分辨率

-
- - - -
- (CGSize)captureDimension
- - - - - - - - - -
-

Discussion

-

参见iOS的 AVCaptureSessionPresetXXX的定义

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– isTorchSupported -

- -
-
- -
- - -
-

当前采集设备是否支持闪光灯

-
- - - -
- (BOOL)isTorchSupported
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - -
-

Discussion

-

通常只有后置摄像头支持闪光灯

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– toggleTorch -

- -
-
- -
- - -
-

开关闪光灯

-
- - - -
- (void)toggleTorch
- - - - - - - - - -
-

Discussion

-

切换闪光灯的开关状态 开 <–> 关

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

– setTorchMode: -

- -
-
- -
- - -
-

设置闪光灯

-
- - - -
- (void)setTorchMode:(AVCaptureTorchMode)mode
- - - -
-

Parameters

- - - - - - - -
mode

AVCaptureTorchModeOn/Off

-
- - - - - - - -
-

Discussion

-

设置闪光灯的开关状态

开始预览后开始有效

请参考 AVCaptureTorchMode

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 原始采集到的音频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题@discussion 请参考 CMSampleBufferRef

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  videoProcessingCallback -

- -
-
- -
- - -
-

视频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 原始采集到的视频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
- -

  interruptCallback -

- -
-
- -
- - -
-

采集被打断的消息通知

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( BOOL bInterrupt ) interruptCallback
- - - - - - - - - -
-

Discussion

-

bInterrupt 为YES, 表明被打断, 采集暂停

bInterrupt 为NO, 表明恢复采集

-
- - - - - - - -
-

Declared In

-

KSYAVFCapture.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAVMuxer.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAVMuxer.html index 85ff877..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAVMuxer.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAVMuxer.html @@ -3,11 +3,11 @@ - KSYAVMuxer Class Reference + - +
@@ -43,44 +43,10 @@

@@ -93,400 +59,15 @@

-

KSYAVMuxer Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAVMuxer.h
- - -
- -

Overview

-

音视频交织工具类

- -
    -
  • 将输入的纯音频文件和纯视频文件交织输出为正常的视频文件
    • -
  • 本工具类不做解码和编码,仅仅将音视频交织
    • -
  • 视频文件要求是只有单路图像, 如果有音频会被丢弃, 音频文件反之
    • -
  • 支持输出的文件格式: flv, MP4
    • -
-
- - - - -
- - - - - - -
-
- -

  bLoopVideo -

- -
-
- -
- - -
-

当视频数据比音频数据短时,是否循环使用视频数据 （默认为NO）

-
- - - -
@property (atomic, assign) BOOL bLoopVideo
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

  bLoopAudio -

- -
-
- -
- - -
-

当音频数据比视频数据短时,是否循环使用音频数据 （默认为NO）

-
- - - -
@property (atomic, assign) BOOL bLoopAudio
- - - - - - - - - -
-

Discussion

-

当bLoopVideo和bLoopAudio都为NO时, 比较长的数据被丢弃

-
- - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

  metadata -

- -
-
- -
- - -
-

最后输出视频文件时附带的metadata (默认为nil)

-
- - - -
@property (atomic, copy) NSDictionary *metadata
- - - - - - - - - -
-

Discussion

-

key 一定要是 NSString* 类型的

-
- - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

– startMuxVideo:andAudio:To: -

- -
-
- -
- - -
-

启动处理(同步)

-
- - - -
- (void)startMuxVideo:(NSURL *)vFile andAudio:(NSURL *)aFile To:(NSURL *)oFile
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
vFile

为输入的纯视频文件的路径

aFile

为输入的音频文件的路径

oFile

为输出文件的路径

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

– asyncMuxVideo:andAudio:To: -

- -
-
- -
- - -
-

启动处理(异步)

-
- - - -
- (void)asyncMuxVideo:(NSURL *)vFile andAudio:(NSURL *)aFile To:(NSURL *)oFile
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
vFile

为输入的纯视频文件的路径

aFile

为输入的音频文件的路径

oFile

为输出文件的路径

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

– cancelMux -

- -
-
- -
- - -
-

中止处理

-
- - - -
- (void)cancelMux
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
- -

  muxCompleteBlock -

- -
-
- -
- - -
-

异步处理完成回调 -@param status

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( KSYAVMuxerStatus status ) muxCompleteBlock
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAVMuxer.h

-
- - -
-
-
-
- -
- - - - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioFilter.html index 1060538..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioFilter.html @@ -3,11 +3,11 @@ - KSYAudioFilter Class Reference + - +
@@ -43,36 +43,10 @@

@@ -85,199 +59,15 @@

-

KSYAudioFilter Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAudioFilter.h
- - -
- -

Overview

-

音频filter -1. 使用filter对音频进行处理，目前支持功能包括： - * 变速 - speed -2. 输出格式与输入格式相同 -3. 建议放在KSYAudioMixer前使用

-
- - - -
- - - - - - -
-
- -

  speed -

- -
-
- -
- - -
-

速率，默认值是1.0

-
- - - -
@property (nonatomic, assign) float speed
- - - - - - - - - -
-

Discussion

-

取值范围从0.5 - 2.0

如果配置速率不在有效范围，则设置不生效

-
- - - - - - - -
-

Declared In

-

KSYAudioFilter.h

-
- - -
-
-
- -

– processAudioSampleBuffer: -

-
-
- -
- - -
-

输入音频PCM

-
- - - -
- (void)processAudioSampleBuffer:(CMSampleBufferRef)inSampleBuffer
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

音频数据

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYAudioFilter.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 经过filter处理后的音频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYAudioFilter.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioInfo.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioInfo.html index 7e1c819..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioInfo.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioInfo.html @@ -3,11 +3,11 @@ - KSYAudioInfo Class Reference + - +
@@ -43,40 +43,10 @@

@@ -89,337 +59,15 @@

-

KSYAudioInfo Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYMediaInfo.h
- - -
- -

Overview

-

音频信息

-
- - - - - -
- - - - - - -
-
- -

  acodec -

- -
-
- -
- - -
-

音频编码格式, 具体类型为MEDIAINFO_CODEC_ID

-
- - - -
@property (nonatomic) MEDIAINFO_CODEC_ID acodec
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  language -

- -
-
- -
- - -
-

音频语言, 如chinese, english…

-
- - - -
@property (nonatomic) NSString *language
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  bitrate -

- -
-
- -
- - -
-

音频码率

-
- - - -
@property (nonatomic, assign) int64_t bitrate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  channels -

- -
-
- -
- - -
-

声道数

-
- - - -
@property (nonatomic, assign) int32_t channels
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  samplerate -

- -
-
- -
- - -
-

音频采样率

-
- - - -
@property (nonatomic, assign) int32_t samplerate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  sample_format -

- -
-
- -
- - -
-

音频采样格式, 具体类型为MEDIAINFO_SAMPLE_FMT

-
- - - -
@property (nonatomic, assign) MEDIAINFO_SAMPLE_FMT sample_format
- - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  framesize -

- -
-
- -
- - -
-

音频帧大小

-
- - - -
@property (nonatomic, assign) int32_t framesize
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioMixer.html b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioMixer.html index 4da9c32..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYAudioMixer.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYAudioMixer.html @@ -3,11 +3,11 @@ - KSYAudioMixer Class Reference + - +
@@ -43,60 +43,10 @@

@@ -109,862 +59,15 @@

-

KSYAudioMixer Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYAudioMixer.h
- - -
- -

Overview

-

多路pcm混音

- -
    -
  1. 用trackId来表示某一路音频，从0开始编号
    2. -
  2. 要求一定要有一路麦克风的音频，其他音频都叠加到麦克风上
    3. -
  3. 将输入的音频pcm数据存入buffer，每一路音频的buffer独立
    4. -
  4. 每次麦克风的音频输入，都会触发从所有buffer中取数据，混合，发送的动作
    5. -
  5. 每一路音频可以单独配置音量
    6. -
  6. 输出格式固定为 44.1KHz, S16 (声道数可设定)
    7. -
-
- - - - -
- - - - - - -
-
- -

– getMaxMixTrack -

- -
-
- -
- - -
-

获取最大支持的混合路数 -*

-
- - - -
- (int)getMaxMixTrack
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– setMixVolume:of: -

- -
-
- -
- - -
-

设置混音音量（默认音量为1.0）

-
- - - -
- (BOOL)setMixVolume:(float)vol of:(int)trackId
- - - -
-

Parameters

- - - - - - - - - - - - -
vol

音量比例（0.0~2.0） (<1.0 为缩小, > 1.0为放大)

trackId

设置对应track的

-
- - - -
-

Return Value

-

NO为设置失败，如track不存在，或vol超出范围

-
- - - - - -
-

Discussion

-

Warning: 设置放大的音量可能会出现爆音, 请注意 -*

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– getMixVolume: -

- -
-
- -
- - -
-

查询track的音量

-
- - - -
- (float)getMixVolume:(int)trackId
- - - -
-

Parameters

- - - - - - - -
trackId

设置对应track的

-
- - - -
-

Return Value

-

负数为查询失败，如track不存在 -*

-
- - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– setTrack:enable: -

- -
-
-
- - -
-

开启/关闭一路声音

-
- - - -
- (BOOL)setTrack:(int)trackId enable:(BOOL)onOff
- - - -
-

Parameters

- - - - - - - - - - - - -
trackId

开关对应track

onOff

开关， 0号track默认开启

-
- - - -
-

Return Value

-

NO为设置失败，比如trackID不存在 -*

-
- - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– getTrackEnable: -

- -
-
- -
- - -
-

查询track是否开启

-
- - - -
- (BOOL)getTrackEnable:(int)trackId
- - - -
-

Parameters

- - - - - - - -
trackId

开关对应track -*

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– getBufLength: -

- -
-
- -
- - -
-

查询track中缓存数据的长度（单位为一次输出的samplebuffer数）

-
- - - -
- (int)getBufLength:(int)trackId
- - - -
-

Parameters

- - - - - - - -
trackId

开关对应track

-
- - - -
-

Return Value

-

<0, 表示查询失败 - =0，表示残余的数据不足一次输出 - >0, 表示可以buffer中的数据还可以输出n次 -*

-
- - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– processAudioSampleBuffer:of: -

- -
-
- -
- - -
-

输入音频PCM

-
- - - -
- (BOOL)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer of:(int)trackId
- - - -
-

Parameters

- - - - - - - - - - - - -
sampleBuffer

音频数据

trackId

设置对应track的

-
- - - -
-

Return Value

-

NO为设置失败，比如trackID不存在

-
- - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

– processAudioData:nbSample:withFormat:timeinfo:of: -

- -
-
- -
- - -
-

输入音频PCM

-
- - - -
- (BOOL)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime)pts of:(int)trackId
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - -
pData

原始数据指针数组,单通道仅pData[0]有效 当输入为多通道且非交织时, pData[i]分别表示各个通道的数据

len

数据的长度，单位为sample (bytes / sizeof(sample))

fmt

原始数据的格式

pts

原始数据的时间戳

trackId

设置对应track的

-
- - - -
-

Return Value

-

NO为设置失败，比如trackID不存在

-
- - - - - -
-

Discussion

-

传入数据为NULL时，仅仅检查是否有数据输出

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 混音后的音频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题

请参考 CMSampleBufferRef

与pcmProcessingCallback两者只能二选一, 设置 audioProcessingCallback 会清空 pcmProcessingCallback

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  pcmProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int nbSample , CMTime pts ) pcmProcessingCallback
- - - - - - - - - -
-

Discussion

-

pData 为数据指针 (双通道时, 数据为交织格式), 仅pData[0] 有效

nbSample 为数据长度, 单位为sample (bytes / sizeof(sample)/channels)

请注意本函数的执行时间，如果太长可能导致不可预知的问题

与audioProcessingCallback两者只能二选一, 设置 pcmProcessingCallback 会清空audioProcessingCallback

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  mainTrack -

- -
-
- -
- - -
-

主轨的trackId （默认为0）

-
- - - -
@property (nonatomic, assign) int mainTrack
- - - - - - - - - -
-

Discussion

-

比如micphone的track，所有track都同步到主轨的时间轴

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  bStereo -

- -
-
- -
- - -
-

输出音频是否为双声道立体声 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL bStereo
- - - - - - - - - -
-

Discussion

-

如果输入数据都不是双声道则输出数据左右耳内容一样

输出立体声的数据格式一定是交织的

-
- - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  frameSize -

- -
-
- -
- - -
-

每一次输出数据(Frame)的sample数, 默认为1024

-
- - - -
@property (nonatomic, assign) int frameSize
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  sampleRate -

- -
-
- -
- - -
-

输出音频的采样率, 默认为44100

-
- - - -
@property (nonatomic, assign) int sampleRate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
- -

  outFmtDes -

- -
-
- -
- - -
-

混音后输出PCM的格式

-
- - - -
@property (nonatomic, readonly) AudioStreamBasicDescription *outFmtDes
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYAudioMixer.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyFaceFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyFaceFilter.html index 8c1b105..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyFaceFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyFaceFilter.html @@ -3,11 +3,11 @@ - KSYBeautifyFaceFilter Class Reference + - +
@@ -43,46 +43,10 @@

@@ -95,318 +59,15 @@

-

KSYBeautifyFaceFilter Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageFilterGroup
Declared inKSYBeautifyFaceFilter.h
- - -
- -

Overview

-

金山云美颜滤镜

- -

磨皮 + 美白 + [红润特效]的美颜滤镜 -其中 红润特效为可选效果. -如果启用, 需要依赖外部的KSYGPUResource.bundle中的资源文件 -详细使用方法参见demo

-
- - - - - -
- - - - - - -
-
- -

– init -

- -
-
- -
- - -
-

init

-
- - - -
- (id)init
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
- -

+ showVersion -

- -
-
- -
- - -
-

show version of this filter

-
- - - -
+ (void)showVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
- -

  grindRatio -

- -
-
- -
- - -
-

grindRatio ranges from 0.0 to 1.0, with 0.87 as the normal level

-
- - - -
@property (readwrite, nonatomic) CGFloat grindRatio
- - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
- -

  whitenRatio -

- -
-
- -
- - -
-

whitenRatio ranges from 0.0 to 1.0, with 0.6 as the normal level

-
- - - -
@property (readwrite, nonatomic) CGFloat whitenRatio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
- -

– initWithRubbyMaterial: -

- -
-
- -
- - -
-

初始化输入的红润特效素材图像

-
- - - -
- (id)initWithRubbyMaterial:(UIImage *)img
- - - -
-

Parameters

- - - - - - - -
img

红润特效素材文件 (比如KSYGPUResource.bundle中的资源文件)

-
- - - -
-

Return Value

-

构造出来的滤镜

-
- - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
- -

  ruddyRatio -

- -
-
- -
- - -
-

ruddyRatio ranges from 0.0 to 1.0, with 1.0 as the normal level, need to use the initWithRubbyMaterial

-
- - - -
@property (readwrite, nonatomic) CGFloat ruddyRatio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyFaceFilter.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyProFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyProFilter.html index bd1c3db..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyProFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYBeautifyProFilter.html @@ -3,11 +3,11 @@ - KSYBeautifyProFilter Class Reference + - +
@@ -45,42 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -93,300 +59,15 @@

-

KSYBeautifyProFilter Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageFilterGroup
Declared inKSYBeautifyProFilter.h
- - -
- - - - - - -
-
- -

– init -

- -
-
- -
- - -
-

init

-
- - - -
- (id)init
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
- -

– initWithIdx: -

- -
-
- -
- - -
-

初始化并指定 1~4 的index来创建对应美颜滤镜

-
- - - -
- (id)initWithIdx:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

效果的索引 (非法值无效)

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
- -

+ showVersion -

- -
-
- -
- - -
-

show version of this filter

-
- - - -
+ (void)showVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
- -

  grindRatio -

- -
-
- -
- - -
-

grindRatio ranges from 0.0 to 1.0, with 0.5 as the normal level

-
- - - -
@property (readwrite, nonatomic) CGFloat grindRatio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
- -

  whitenRatio -

- -
-
- -
- - -
-

whitenRatio ranges from 0.0 to 1.0, with 0.3 as the normal level

-
- - - -
@property (readwrite, nonatomic) CGFloat whitenRatio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
- -

  ruddyRatio -

- -
-
- -
- - -
-

ruddyRatio ranges from -1.0 to 1.0, with -0.3 as the normal level

-
- - - -
@property (readwrite, nonatomic) CGFloat ruddyRatio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBeautifyProFilter.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYBgmPlayer.html b/doc/docset/Contents/Resources/Documents/Classes/KSYBgmPlayer.html index 3ed3d30..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYBgmPlayer.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYBgmPlayer.html @@ -3,11 +3,11 @@ - KSYBgmPlayer Class Reference + - +
@@ -43,76 +43,10 @@

@@ -125,1131 +59,23 @@

-

KSYBgmPlayer Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYBgmPlayer.h
- - -
- -

Overview

-

背景音乐播放器

-
提供背景音乐播放的功能, 并能将被播放的音频数据通过回调送出
-
-
- - - -
- - + +
- - - -
-
- -

– startPlayBgm:isLoop: -

- -
-
- -
- - -
-

开始播放背景音乐

-
- - - -
- (BOOL)startPlayBgm:(NSString *)path isLoop:(BOOL)loop
- - - -
-

Parameters

- - - - - - - - - - - - -
path

本地音乐的路径

loop

是否循环播放此音乐

-
- - - -
-

Return Value

-

是否能够开始播放

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– stopPlayBgm -

- -
-
- -
- - -
-

停止播放背景音乐

-
- - - -
- (void)stopPlayBgm
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– stopPlayBgm: -

- -
-
- -
- - -
-

停止播放背景音乐 -@param 停止完成的回调函数

-
- - - -
- (void)stopPlayBgm:(void ( ^ ) ( ))completion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– pauseBgm -

- -
-
- -
- - -
-

暂停播放背景音乐

-
- - - -
- (void)pauseBgm
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– resumeBgm -

- -
-
- -
- - -
-

恢复播放背景音乐

-
- - - -
- (void)resumeBgm
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– seekToTime: -

- -
-
- -
- - -
-

seek到指定时间 (拖动进度条)

-
- - - -
- (BOOL)seekToTime:(float)time
- - - -
-

Parameters

- - - - - - - -
time

时间, 请参考 bgmDuration (单位,秒)

-
- - - -
-

Return Value

-

是否seek 成功

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– seekToProgress: -

- -
-
- -
- - -
-

seek到指定进度 (拖动进度条)

-
- - - -
- (BOOL)seekToProgress:(float)prog
- - - -
-

Parameters

- - - - - - - -
prog

进度, 请参考 bgmProgress

-
- - - -
-

Return Value

-

是否seek 成功

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmVolume -

- -
-
- -
- - -
-

背景音乐的音量

-
- - - -
@property (nonatomic, assign) double bgmVolume
- - - - - - - - - -
-

Discussion

-

调整范围 0.0~1.0

仅仅调整播放的音量, 不影响回调的音频数据

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmPitch -

- -
-
- -
- - -
-

播放声音的音调

-
- - - -
@property (nonatomic, assign) double bgmPitch
- - - - - - - - - -
-

Discussion

-

调整范围 [-24.0 ~ 24.0], 默认为0.01, 单位为半音

0.01 为1度, 1.0为一个半音, 12个半音为1个八度

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  playRate -

- -
-
- -
- - -
-

播放速率

-
- - - -
@property (nonatomic, assign) double playRate
- - - - - - - - - -
-

Discussion

-

调整范围 0.5 ~ 2.0，默认值 1.0

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bMuteBgmPlay -

- -
-
- -
- - -
-

背景音乐播放静音

-
- - - -
@property (nonatomic, assign) BOOL bMuteBgmPlay
- - - - - - - - - -
-

Discussion

-

仅仅静音播放, 不影响回调的音频数据

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  callBackRawData -

- -
-
- -
- - -
-

设置 audioDataBlock 是否返回原始数据

-
- - - -
@property (nonatomic, assign) BOOL callBackRawData
- - - - - - - - - -
-

Discussion

-

默认为NO，audioDataBlock 返回的数据为经过变速、变调后的数据 - 如果为YES，audioDataBlock 返回的数据为原始数据

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  audioDataBlock -

- -
-
- -
- - -
-

音频数据输出回调

-
- - - -
@property (nonatomic, copy) BOOL ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime pts ) audioDataBlock
- - - - - - - - - -
-

Discussion

-

sampleBuffer 从音乐文件中解码得到的PCM数据

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmFinishBlock -

- -
-
- -
- - -
-

当背景音乐播放完成时，调用此回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( void ) bgmFinishBlock
- - - - - - - - - -
-

Discussion

-

只有设置 loop为NO时才有效, 在开始播放前设置有效

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmDuration -

- -
-
- -
- - -
-

背景音的duration信息（总时长, 单位:秒）

-
- - - -
@property (nonatomic, readonly) float bgmDuration
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmPlayTime -

- -
-
- -
- - -
-

背景音的已经播放长度 (单位:秒)

-
- - - -
@property (nonatomic, readonly) float bgmPlayTime
- - - - - - - - - -
-

Discussion

-

从0开始，最大为bgmDuration长度

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmProcess -

- -
-
- -
- - -
-

音频的播放进度

-
- - - -
@property (nonatomic, readonly) float bgmProcess
- - - - - - - - - -
-

Discussion

-

取值从0.0~1.0，大小为bgmPlayTime/bgmDuration;

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  isRunning -

- -
-
- -
- - -
-

音频播放是否运行

-
- - - -
@property (nonatomic, readonly) BOOL isRunning
- - - - - - - - - -
-

Discussion

-

音频是否输出到speaker播放

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  audioErrorCode -

- -
-
- -
- - -
-

播放错误码

-
- - - -
@property (nonatomic, readonly) OSStatus audioErrorCode
- - - - - - - - - -
-

Discussion

-

播放错误码具体内容可以参考AudioQueue的Apple文档。

-
- - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bgmPlayerState -

- -
-
- -
- - -
-

播放状态

-
- - - -
@property (nonatomic, readonly) KSYBgmPlayerState bgmPlayerState
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

  bLoop -

- -
-
- -
- - -
-

单曲循环

-
- - - -
@property (nonatomic, assign) BOOL bLoop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– getBgmStateName: -

- -
-
- -
- - -
-

获取状态对应的字符串

-
- - - -
- (NSString *)getBgmStateName:(KSYBgmPlayerState)stat
- - - -
-

Parameters

- - - - - - - -
stat

状态

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
- -

– getCurBgmStateName -

- -
-
- -
- - -
-

获取当前状态对应的字符串

-
- - - -
- (NSString *)getCurBgmStateName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmPlayer.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYBgmReader.html b/doc/docset/Contents/Resources/Documents/Classes/KSYBgmReader.html index 1127b57..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYBgmReader.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYBgmReader.html @@ -3,11 +3,11 @@ - KSYBgmReader Class Reference + - +
@@ -43,52 +43,10 @@

@@ -101,616 +59,15 @@

-

KSYBgmReader Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYBgmReader.h
- - -
- -

Overview

-

背景音乐文件解码

- -
提供背景音乐文件解码的功能,将解码后的音频数据通过回调送出
-输出数据的格式满足如下规律:
 
-* 一定是S16的线性PCM
-* 如果是双通道,一定是交织的数据
-
-
- - - - - -
- - - - - - -
-
- -

– initWithFile:isLoop: -

- -
-
- -
- - -
-

构造音乐文件对应的reader

-
- - - -
- (id)initWithFile:(NSString *)path isLoop:(BOOL)loop
- - - -
-

Parameters

- - - - - - - - - - - - -
path

本地音乐的路径

loop

是否循环播放此音乐

-
- - - -
-

Return Value

-

self

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

– reloadFile: -

- -
-
- -
- - -
-

reload 一个新的文件到reader中

-
- - - -
- (BOOL)reloadFile:(NSString *)path
- - - -
-

Parameters

- - - - - - - -
path

本地音乐的路径

-
- - - -
-

Return Value

-

path对应的文件是否有效

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

– closeFile -

- -
-
- -
- - -
-

关闭文件

-
- - - -
- (void)closeFile
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

– seekTo: -

- -
-
- -
- - -
-

seek到指定时间 (拖动进度条)

-
- - - -
- (BOOL)seekTo:(float)time
- - - -
-

Parameters

- - - - - - - -
time

时间, 请参考 bgmDuration (单位,秒)

-
- - - -
-

Return Value

-

是否seek 成功

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

  bgmFmt -

- -
-
- -
- - -
-

音乐的格式信息 (一定为S16的数据格式)

-
- - - -
@property (nonatomic, readonly) AudioStreamBasicDescription bgmFmt
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

– readPCMData:nbSample: -

- -
-
- -
- - -
-

从文件中读取一段音频数据 (二选一)

-
- - - -
- (int)readPCMData:(AudioBufferList *)buf nbSample:(UInt32)cnt
- - - -
-

Parameters

- - - - - - - -
buf,

待填充的音频数据 请保证buf.mDataByteSize 先设置为需要读取的字节数

-
- - - -
-

Return Value

-

-1: 解码遇到错误, 请检查音乐文件是否有效 - 0: 文件读取完毕, 无法提供更多数据 (loop时不会返回0) - 1: 读取正常

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

– readPCMData:capacity: -

- -
-
- -
- - -
-

从文件中读取一段音频数据 (二选一)

-
- - - -
- (int)readPCMData:(void *)buf capacity:(UInt32)cap
- - - -
-

Parameters

- - - - - - - - - - - - -
buf,

待填充的音频数据(只会输出交织后的数据, 因此只有一个数据指针)

cap,

buf的空间大小

-
- - - -
-

Return Value

-

-1: 解码遇到错误, 请检查音乐文件是否有效 - >0: 读取正常, 数值为实际取到的数据字节数

-
- - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

  bgmDuration -

- -
-
- -
- - -
-

背景音的duration信息（总时长, 单位:秒）

-
- - - -
@property (nonatomic, readonly) float bgmDuration
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

  bgmPlayTime -

- -
-
- -
- - -
-

背景音的已经播放长度 (单位:秒)

-
- - - -
@property (nonatomic, readonly) float bgmPlayTime
- - - - - - - - - -
-

Discussion

-

从0开始，最大为bgmDuration长度

-
- - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

  bgmProcess -

- -
-
- -
- - -
-

音频的播放进度

-
- - - -
@property (nonatomic, readonly) float bgmProcess
- - - - - - - - - -
-

Discussion

-

取值从0.0~1.0，大小为bgmPlayTime/bgmDuration;

-
- - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
- -

  bLoop -

- -
-
- -
- - -
-

单曲循环

-
- - - -
@property (nonatomic, assign) BOOL bLoop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYBgmReader.h

-
- - -
-
-
-
- -
- - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYBuildInSpecialEffects.html b/doc/docset/Contents/Resources/Documents/Classes/KSYBuildInSpecialEffects.html index 478e217..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYBuildInSpecialEffects.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYBuildInSpecialEffects.html @@ -3,11 +3,11 @@ - KSYBuildInSpecialEffects Class Reference + - +
@@ -43,30 +43,10 @@

@@ -79,172 +59,15 @@

-

KSYBuildInSpecialEffects Class Reference

+

-
- - - - - - - -
Inherits fromKSYSpecialEffects : GPUImageFilterGroup
Declared inKSYBuildInSpecialEffects.h
- - -
- -

Overview

-

KSY 特效滤镜

- -

内置滤镜需要资源文件支持(KSYResource.bundle) -目前内置了如下6中特效: -1 小清新 -2 靓丽 -3 甜美可人 -4 怀旧 -5 蓝调 -6 老照片 -7 樱花 -8 樱花（光线较暗） -9 红润（光线较暗） -10 阳光（光线较暗） -11 红润 -12 阳光 -13 自然

-
- - - - - -
- - - - - - -
-
- -

– initWithIdx: -

- -
-
- -
- - -
-

初始化并指定 1~13 的index来创建对应效果

-
- - - -
- (id)initWithIdx:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

效果的索引 (非法值无效)

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYBuildInSpecialEffects.h

-
- - -
-
-
- -

– setSpecialEffectsIdx: -

- -
-
- -
- - -
-

指定 1~6 的index来创建对应效果

-
- - - -
- (void)setSpecialEffectsIdx:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

效果的索引 (非法值无效)

-
- - - - - - - - - - - - -
-

Declared In

-

KSYBuildInSpecialEffects.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYClipWriter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYClipWriter.html index 85c3526..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYClipWriter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYClipWriter.html @@ -3,11 +3,11 @@ - KSYClipWriter Class Reference + - +
@@ -43,108 +43,10 @@

@@ -157,1979 +59,23 @@

-

KSYClipWriter Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYClipWriter.h
- - -
- -

Overview

-

金山云转码SDK iOS版提供了iOS移动设备上的转码合成功能

- -
    -
  • 音频编码采用AAC编码，码率可配置;
    • -
  • 视频频编码采用H.264、H.265编码，码率可配置;
    • -
  • 支持写入本地flv和mp4文件;
    • -
- -

Found: 2017-4-7

-
- - - -
- - + +
- - - -
-
- -

– getKSYVersion -

- -
-
- -
- - -
-

获取SDK版本号

-
- - - -
- (NSString *)getKSYVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  hostURL -

- -
-
- -
- - -
-

本地录制,输出路径

-
- - - -
@property (nonatomic, readonly) NSURL *hostURL
- - - - - - - - - -
-

Discussion

-

将音视频流写入本地文件 -eg: /var/xxxxx/xxx.mp4 /var/xxxxx/xxx.flv

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoFPS -

- -
-
- -
- - -
-

视频帧率

-
- - - -
@property (nonatomic, assign) int videoFPS
- - - - - - - - - -
-

Discussion

-

本地录制的视频帧率，开启编码前丢帧时，帧率生效

编码前丢帧shouldEnableKSYDropModule为YES时，帧率设置生效

编码前丢帧shouldEnableKSYDropModule为NO时，帧率保持与输入帧率一致

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoCodec -

- -
-
- -
- - -
-

视频编码器 默认为 自动选择

-
- - - -
@property (nonatomic, assign) KSYVideoCodec videoCodec
- - - - - - - - - -
-

Discussion

-

video codec used for encode

修改此选项会导致videoEncodePerf值变化

如果需要定制编码档次, 请在修改videoCodec之后再测设置

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  audioCodec -

- -
-
- -
- - -
-

音频编码器 (默认为AAC-HE)

-
- - - -
@property (nonatomic, assign) KSYAudioCodec audioCodec
- - - - - - - - - -
-

Discussion

-

audio codec used for encode

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoInitBitrate -

- -
-
- -
- - -
-

视频编码码率（单位:kbps, 默认:500）

-
- - - -
@property (nonatomic, assign) int videoInitBitrate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  streamMetaData -

- -
-
- -
- - -
-

写入全局附带的metadata (默认为nil)

-
- - - -
@property (atomic, copy) NSDictionary *streamMetaData
- - - - - - - - - -
-

Discussion

-

key 一定要是 NSString* 类型的

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoMetaData -

- -
-
- -
- - -
-

视频流附带的metadata (默认为nil)

-
- - - -
@property (atomic, copy) NSDictionary *videoMetaData
- - - - - - - - - -
-

Discussion

-

key 一定要是 NSString* 类型的; 目前有效

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoCrf -

- -
-
- -
- - -
-

质量等级（默认:20）

-
- - - -
@property (nonatomic, assign) int videoCrf
- - - - - - - - - -
-

Discussion

-

视频恒定质量等级，范围0～51，值越小，质量越好

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  maxKeyInterval -

- -
-
- -
- - -
-

最大关键帧间隔（单位:秒, 默认:3）

-
- - - -
@property (nonatomic, assign) float maxKeyInterval
- - - - - - - - - -
-

Discussion

-

即GOP长度 画面静止时,隔n秒插入一个关键帧

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  audiokBPS -

- -
-
- -
- - -
-

音频编码码率（单位:kbps）

-
- - - -
@property (nonatomic, assign) int audiokBPS
- - - - - - - - - -
-

Discussion

-

音频目标编码码率 (比如48,96,128等)

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  liveScene -

- -
-
- -
- - -
-

待编码的视频场景 (默认为KSYLiveScene_Default)

-
- - - -
@property (nonatomic, assign) KSYLiveScene liveScene
- - - - - - - - - -
-

Discussion

-

KSY内部会根据场景的特征进行参数调优,开始录制前设置有效

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  recScene -

- -
-
- -
- - -
-

编码的目标场景 (默认为KSYRecScene_ConstantBitRate)

-
- - - -
@property (nonatomic, assign) KSYRecScene recScene
- - - - - - - - - -
-

Discussion

-

开始编码前设置有效

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoEncodePerf -

- -
-
- -
- - -
-

视频编码性能档次

-
- - - -
@property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf
- - - - - - - - - -
-

Discussion

-

视频质量和设备资源之间的权衡,开始推流前, videoCodec设置之后,修改有效

选择软编码的默认为KSYVideoEncodePer_LowPower

选择Auto或硬编码的默认为KSYVideoEncodePer_HighPerformance

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  bWithVideo -

- -
-
- -
- - -
-

是否处理视频的图像数据 (默认YES)

-
- - - -
@property (nonatomic, assign) BOOL bWithVideo
- - - - - - - - - -
-

Discussion

-

Warning: 启动合成前设置为NO, 则在转码过程中无法再开启图像

启动合成前设置为NO, 写入过程中修改本属性无效

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  bWithAudio -

- -
-
- -
- - -
-

是否处理音频数据 (默认YES)

-
- - - -
@property (nonatomic, assign) BOOL bWithAudio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  writeState -

- -
-
- -
- - -
-

当前写入状态

-
- - - -
@property (nonatomic, readonly) KSYStreamState writeState
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取写入的工作状态

通知： -* KSYStreamStateDidChangeNotification 当写入工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– getWriteStateName: -

- -
-
- -
- - -
-

获取写入状态对应的字符串

-
- - - -
- (NSString *)getWriteStateName:(KSYStreamState)stat
- - - -
-

Parameters

- - - - - - - -
stat

状态码

-
- - - -
-

Return Value

-

状态名称

-
- - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– getCurWriteStateName -

- -
-
- -
- - -
-

获取当前写入状态对应的字符串

-
- - - -
- (NSString *)getCurWriteStateName
- - - - - -
-

Return Value

-

当前状态名称

-
- - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  streamErrorCode -

- -
-
- -
- - -
-

当前转码/写入的错误码

-
- - - -
@property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取写入失败的原因

当streamState 为KSYStreamStateError时可查询

KSYStreamErrorCode_KSYAUTHFAILED 除外

在streamState 为KSYStreamStateConnected 时查询到

状态变化后清0

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  writeStateChange -

- -
-
- -
- - -
-

数据流写入状态变化时的回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) writeStateChange
- - - - - - - - - -
-

Discussion

-

参数为新状态

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– getKSYWriteErrorCodeName: -

- -
-
- -
- - -
-

获取错误码对应的字符串

-
- - - -
- (NSString *)getKSYWriteErrorCodeName:(KSYStreamErrorCode)code
- - - -
-

Parameters

- - - - - - - -
code

错误码

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– getCurKSYWriteErrorCodeName -

- -
-
- -
- - -
-

获取当前错误码对应的字符串

-
- - - -
- (NSString *)getCurKSYWriteErrorCodeName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  videoFPSChange -

- -
-
- -
- - -
-

帧率应发生变化时的回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange
- - - - - - - - - -
-

Discussion

-

参数为建议设定的fps

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– initWithDefaultCfg -

- -
-
- -
- - -
-

初始化方法 （step1）

-
- - - -
- (instancetype)initWithDefaultCfg
- - - - - - - - - -
-

Discussion

-

初始化，将下列属性设置为默认值

- - -

Warning: KSYClipWriter只支持单实例写入，构造多个实例会出现异常

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– startWritingWith: -

- -
-
- -
- - -
-

启动写入文件 （step2）

-
- - - -
- (void)startWritingWith:(NSURL *)url
- - - - - - - - - -
-

Discussion

-

本地写入支持mp4和flv两种输出格式,通过url的文件后缀指定

“/var/xxx/xx.mp4”, “/var/xxx/xx.flv”

写入参数主要是视频编码器，音视频码率的设置

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– stopWriting -

- -
-
- -
- - -
-

停止写入 （step3）

-
- - - -
- (void)stopWriting
- - - - - - - - - -
-

Discussion

-

停止文件写入

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– stopWriting: -

- -
-
- -
- - -
-

停止写入 （step3）

-
- - - -
- (void)stopWriting:(void ( ^ ) ( ))complete
- - - -
-

Parameters

- - - - - - - -
complete

完成回调

-
- - - - - - - -
-

Discussion

-

停止文件写入

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– muteStream: -

- -
-
- -
- - -
-

静音 (仍然有音频，只是音量为0)

-
- - - -
- (void)muteStream:(BOOL)bMute
- - - -
-

Parameters

- - - - - - - -
bMute

YES / ON

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– processVideoSampleBuffer:onComplete: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion
- - - -
-

Parameters

- - - - - - - - - - - - -
sampleBuffer

Buffer to process

completion

当前视频帧处理完成的回调

-
- - - - - - - -
-

Discussion

-

应当在开始写入前定期调用此接口，比如按照采集帧率调用

支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– processVideoPixelBuffer:timeInfo:onComplete: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
pixelBuffer

待编码的像素数据

timeStamp

待编码的时间戳

completion

当前视频帧处理完成的回调

-
- - - - - - - -
-

Discussion

-

应当在开始写入前定期调用此接口，比如按照采集帧率调用

支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– processAudioSampleBuffer: -

- -
-
- -
- - -
-

处理一段音频数据

-
- - - -
- (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

Buffer to process

-
- - - - - - - -
-

Discussion

-

应当在开始写入前定期调用此接口，与processVideoSampleBuffer 交错进行

Warning: 目前只支持 单通道 S16 格式的PCM数据

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

– isWriting -

- -
-
- -
- - -
-

查询当前是否处于写入状态 (connecting, 或connected)

-
- - - -
- (BOOL)isWriting
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  encodeVKbps -

- -
-
- -
- - -
-

查询当前编码的视频码率大小（每秒更新）

-
- - - -
@property (nonatomic, readonly) double encodeVKbps
- - - - - - - - - -
-

Discussion

-

该码率为编码器产生的视频码率大小，单位为kbps

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  encodeAKbps -

- -
-
- -
- - -
-

查询当前编码的音频码率大小（每秒更新）

-
- - - -
@property (nonatomic, readonly) double encodeAKbps
- - - - - - - - - -
-

Discussion

-

该码率为编码器产生的音频码率大小，单位为kbps

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  encodingFPS -

- -
-
- -
- - -
-

查询当前编码的平均视频帧率

-
- - - -
@property (nonatomic, readonly) double encodingFPS
- - - - - - - - - -
-

Discussion

-

采集设备的输出帧率为videoFPS，约等于编码的目标帧率

编码的视频帧率不会高于采集帧率，但是当CPU资源不足时，编码帧率会低于采集帧率

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  encodedFrames -

- -
-
- -
- - -
-

查询本次视频写入已经编码的总帧数

-
- - - -
@property (nonatomic, readonly) int encodedFrames
- - - - - - - - - -
-

Discussion

-

从开始写入到现在，编码过的视频总帧数

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  logBlock -

- -
-
- -
- - -
-

clip writer

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
- - - - - - - - - -
-

Discussion

-

相关字段说明请联系金山云技术支持

-
- - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
- -

  shouldEnableKSYDropModule -

- -
-
- -
- - -
-

是否允许编码前丢帧，默认开启（videoFPS生效） -@warnning 离线转码需要输出所有帧的情况下开启，videoFPS将不生效，根据输入源的fps保持一致

-
- - - -
@property (nonatomic, assign) BOOL shouldEnableKSYDropModule
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYClipWriter.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYDummyAudioSource.html b/doc/docset/Contents/Resources/Documents/Classes/KSYDummyAudioSource.html index 1c80cef..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYDummyAudioSource.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYDummyAudioSource.html @@ -3,11 +3,11 @@ - KSYDummyAudioSource Class Reference + - +
@@ -43,46 +43,10 @@

@@ -95,437 +59,15 @@

-

KSYDummyAudioSource Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYDummyAudioSource.h
- - -
- -

Overview

-

静音音频数据源

-

和音频采集模块类型能够实时产生音频数据, 但是音量都为0 -主要用于真实音频采集需要被暂停时,用于持续产生音频数据避免中断

-
- - - - -
- - - - - - -
-
- -

– initWithAudioFmt: -

- -
-
- -
- - -
-

构造函数

-
- - - -
- (id)initWithAudioFmt:(AudioStreamBasicDescription)asbd
- - - -
-

Parameters

- - - - - - - -
asbd

输入的音频格式

-
- - - -
-

Return Value

-

新实例

-
- - - - - - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

– start -

- -
-
- -
- - -
-

启动产生数据

-
- - - -
- (BOOL)start
- - - - - -
-

Return Value

-

是否启动成功

-
- - - - - -
-

Discussion

-

自动生成系统时间戳

-
- - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

– startAt: -

- -
-
- -
- - -
-

启动产生数据

-
- - - -
- (BOOL)startAt:(CMTime)initPts
- - - -
-

Parameters

- - - - - - - -
initPts

设置启动时间戳

-
- - - -
-

Return Value

-

是否启动采集成功

-
- - - - - -
-

Discussion

-

内部都会先将时间戳的timescale转为ns

-
- - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

– stop -

- -
-
- -
- - -
-

停止产生数据

-
- - - -
- (void)stop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

静音音频数据输出回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 生成的音频数据

-
- - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

  asbd -

- -
-
- -
- - -
-

format description for audio data -默认PCM格式为: (Float32), 单声道, 44100Hz

-
- - - -
@property (nonatomic, assign) AudioStreamBasicDescription asbd
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

  nbSample -

- -
-
- -
- - -
-

每次尝试产生的数据长度 (sample数, 默认为1024) -实际每次产生的音频的数据长度不确定, 应该是在nbSample附近波动

-
- - - -
@property (nonatomic, assign) int nbSample
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
- -

  bRunning -

- -
-
- -
- - -
-

当前是否正在工作

-
- - - -
@property (nonatomic, readonly) BOOL bRunning
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYDummyAudioSource.h

-
- - -
-
-
-
- -
- - - - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyExtFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyExtFilter.html index 8d0c384..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyExtFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyExtFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyExtFilter Class Reference + - +
@@ -43,28 +43,10 @@

@@ -77,103 +59,15 @@

-

KSYGPUBeautifyExtFilter Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUFilter : GPUImageFilter
Declared inKSYGPUBeautifyExtFilter.h
- - -
- -

Overview

-

扩展增强美颜滤镜

-
- - - - - -
- - - - - - -
-
- -

– setBeautylevel: -

- -
-
- -
- - -
-

美颜的等级

-
- - - -
- (void)setBeautylevel:(int)level
- - - -
-

Parameters

- - - - - - - -
level

1 ~ 5，逐级增强, 默认为3

-
- - - - - - - - - - - - -
-

Declared In

-

KSYGPUBeautifyExtFilter.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyFilter.html index d702fce..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyFilter Class Reference + - +
@@ -43,28 +43,10 @@

@@ -77,105 +59,15 @@

-

KSYGPUBeautifyFilter Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUFilter : GPUImageFilter
Declared inKSYGPUBeautifyFilter.h
- - -
- -

Overview

-

金山云美颜滤镜

-

美颜滤镜

-
- - - - -
- - - - - - -
-
- -

– setBeautylevel: -

-
-
- -
- - -
-

美颜的等级

-
- - - -
- (void)setBeautylevel:(int)level
- - - -
-

Parameters

- - - - - - - -
level

1 ~ 5，逐级增强, 默认为3

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBeautifyFilter.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyPlusFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyPlusFilter.html index 095671d..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyPlusFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBeautifyPlusFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyPlusFilter Class Reference + - +
@@ -43,28 +43,10 @@

@@ -77,103 +59,15 @@

-

KSYGPUBeautifyPlusFilter Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUFilter : GPUImageFilter
Declared inKSYGPUBeautifyPlusFilter.h
- - -
- -

Overview

-

增强美颜滤镜

-
- - - - - -
- - - - - - -
-
- -

– setBeautylevel: -

- -
-
- -
- - -
-

美颜的等级

-
- - - -
- (void)setBeautylevel:(int)level
- - - -
-

Parameters

- - - - - - - -
level

1 ~ 5，逐级增强, 默认为3

-
- - - - - - - - - - - - -
-

Declared In

-

KSYGPUBeautifyPlusFilter.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgmStreamerKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgmStreamerKit.html index da6a6ba..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgmStreamerKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgmStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBgmStreamerKit Class Reference + - +
@@ -45,38 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -89,312 +59,15 @@

-

KSYGPUBgmStreamerKit Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUStreamerKit : NSObject
Declared inKSYGPUBgmStreamerKit.h
- - -
- - - - - - -
-
- -

  ksyBgmPlayer -

- -
-
- -
- - -
-

背景音乐播放器

-
- - - -
@property (nonatomic, strong) KSYMoviePlayerController *ksyBgmPlayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
- -

– startPlayBgm: -

- -
-
- -
- - -
-

开始播放背景音乐

-
- - - -
- (void)startPlayBgm:(NSString *)path
- - - -
-

Parameters

- - - - - - - -
path

背景音乐的路径

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
- -

– stopPlayBgm -

- -
-
- -
- - -
-

停止播放背景音乐

-
- - - -
- (void)stopPlayBgm
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
- -

– getBgmStateName: -

- -
-
- -
- - -
-

获取状态对应的字符串

-
- - - -
- (NSString *)getBgmStateName:(MPMoviePlaybackState)stat
- - - -
-

Parameters

- - - - - - - -
stat

状态

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
- -

– getCurBgmStateName -

- -
-
- -
- - -
-

获取当前状态对应的字符串

-
- - - -
- (NSString *)getCurBgmStateName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
- -

  BgmState -

- -
-
- -
- - -
-

播放状态

-
- - - -
@property (nonatomic, readonly) MPMoviePlaybackState BgmState
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBgmStreamerKit.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgpStreamerKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgpStreamerKit.html index a2ab6c3..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgpStreamerKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBgpStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBgpStreamerKit Class Reference + - +
@@ -45,102 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -153,1716 +59,16 @@

-

KSYGPUBgpStreamerKit Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYGPUBgpStreamerKit.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

-
- - -
-
-
- -

  vPreviewMixer -

- -
-
- -
- - -
-

图像混合器 for 预览

-
- - - -
@property (nonatomic, readonly) KSYGPUPicMixer *vPreviewMixer
- - - - - - - - - -
-

Discussion

-

将多图层的内容叠加

-
- - - - - - - -
-

Declared In

-

KSYGPUBgpStreamerKit.h

-
- - -
-
-
- -

  vStreamMixer -

- -
-
- -
- - -
-

图像混合器 for 推流

-
- - - -
@property (nonatomic, readonly) KSYGPUPicMixer *vStreamMixer
- - - - - - - - - -
-

Discussion

-

将多图层的内容叠加

-
- - - - - - - -
-

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

-
    -
  1. 通过它来设置推流参数
    2. -
-
    -
  1. 通过它来启动，停止推流
    2. -
- -
- - - - - - - -
-

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

- -
- - - -
-

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: -

- -
-
- -
- - -
-

设置当前使用的滤镜

-
- - - -
- (void)setupFilter:(GPUImageOutput<GPUImageInput> *)filter
- - - - - - - - - -
-

Discussion

-

若filter 为nil， 则关闭滤镜

若filter 为GPUImageFilter的实例，则使用该滤镜做处理

filter 也可以是GPUImageFilterGroup的实例，可以将多个滤镜组合

-
- - - - - - - -
-

Declared In

-

KSYGPUBgpStreamerKit.h

-
- - -
-
-
- -

– 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

-
- - -
-
-
-
- -
- - - - - - -
+ +
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBrushStreamerKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBrushStreamerKit.html index 9a06a77..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBrushStreamerKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUBrushStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBrushStreamerKit Class Reference + - +
@@ -45,34 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - @@ -85,216 +59,15 @@

-

KSYGPUBrushStreamerKit Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUStreamerKit : NSObject
Declared inKSYGPUBrushStreamerKit.h
- - -
- - - - - - -
-
- -

  drawPicRect -

- -
-
- -
- - -
-

绘制图片的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect drawPicRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUBrushStreamerKit.h

-
- - -
-
-
- -

  drawLayer -

- -
-
- -
- - -
-

画笔图层

-
- - - -
@property (nonatomic, readonly) NSInteger drawLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBrushStreamerKit.h

-
- - -
-
-
- -

  drawPic -

- -
-
- -
- - -
-

绘制的图片

-
- - - -
@property (nonatomic, readwrite) KSYGPUViewCapture *drawPic
- - - - - - - - - -
-

Discussion

-

设置为nil为清除内容图片

-
- - - - - - - -
-

Declared In

-

KSYGPUBrushStreamerKit.h

-
- - -
-
-
- -

– removeDrawLayer -

- -
-
- -
- - -
-

去掉画笔图层

-
- - - -
- (void)removeDrawLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUBrushStreamerKit.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUCamera.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUCamera.html index 48ee432..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUCamera.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUCamera.html @@ -3,11 +3,11 @@ - KSYGPUCamera Class Reference + - +
@@ -43,50 +43,10 @@

@@ -99,470 +59,15 @@

-

KSYGPUCamera Class Reference

+

-
- - - - - - - - - - -
Inherits fromGPUImageVideoCamera
Conforms toAVCaptureAudioDataOutputSampleBufferDelegate
AVCaptureVideoDataOutputSampleBufferDelegate
Declared inKSYGPUCamera.h
- - -
- -

Overview

-

基于 AVFoundation的 音视频采集模块

-
    -
  • 通过回调将采集的音频和视频数据传出
    • -
  • 将摄像头和音频的常用操作进行封装
    • -
  • 注意: 同时使用AVFoundation的音视频采集, 可能无法使用后台采集的功能
    • -
  • 音频采集为可选项
    • -
- -
- - - - -
- - - - - - -
-
- -

– initWithSessionPreset:cameraPosition: -

- -
-
- -
- - -
-

Begin a capture session

-
- - - -
- (id)initWithSessionPreset:(NSString *)sessionPreset cameraPosition:(AVCaptureDevicePosition)cameraPosition
- - - -
-

Parameters

- - - - - - - - - - - - -
sessionPreset

Session preset to use

cameraPosition

Camera to capture from

-
- - - -
-

Return Value

-

nil 表明cameraPosition对应的sessionPreset不支持，初始化不成功

-
- - - - - -
-

Discussion

-

See AVCaptureSession for acceptable values

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

– isTorchSupported -

- -
-
- -
- - -
-

当前采集设备是否支持闪光灯

-
- - -
- (BOOL)isTorchSupported
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - -
-

Discussion

-

通常只有后置摄像头支持闪光灯

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

– toggleTorch -

- -
-
- -
- - -
-

开关闪光灯

-
- - - -
- (void)toggleTorch
- - - - - - - - - -
-

Discussion

-

切换闪光灯的开关状态 开 <–> 关

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

– setTorchMode: -

- -
-
- -
- - -
-

设置闪光灯

-
- - - -
- (void)setTorchMode:(AVCaptureTorchMode)mode
- - - -
-

Parameters

- - - - - - - -
mode

AVCaptureTorchModeOn/Off

-
- - - - - - - -
-

Discussion

-

设置闪光灯的开关状态

开始预览后开始有效

请参考 AVCaptureTorchMode

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

  isRunning -

- -
-
- -
- - -
-

判断是否运行

-
- - - -
@property (readonly, nonatomic) BOOL isRunning
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 原始采集到的音频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题@discussion 请参考 CMSampleBufferRef

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

  videoProcessingCallback -

- -
-
- -
- - -
-

视频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 原始采集到的视频数据

请注意本函数的执行时间，如果太长可能导致不可预知的问题

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
- -

+ getCapOrientation: -

- -
-
- -
- - -
-

UIInterfaceOrientation 转 AVCaptureVideoOrientation

-
- - - -
+ (AVCaptureVideoOrientation)getCapOrientation:(UIInterfaceOrientation)orien
- - - -
-

Parameters

- - - - - - - -
orien

UI的朝向

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUCamera.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUDnoiseFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUDnoiseFilter.html index 1633619..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUDnoiseFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUDnoiseFilter.html @@ -3,11 +3,11 @@ - KSYGPUDnoiseFilter Class Reference + - +
@@ -43,20 +43,10 @@

@@ -69,37 +59,15 @@

-

KSYGPUDnoiseFilter Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUFilter : GPUImageFilter
Declared inKSYGPUDnoiseFilter.h
- - -
- -

Overview

-

去噪滤镜

-
- - - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUFilter.html index c41a5a3..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUFilter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUFilter.html @@ -3,11 +3,11 @@ - KSYGPUFilter Class Reference + - +
@@ -43,30 +43,10 @@

@@ -79,150 +59,15 @@

-

KSYGPUFilter Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageFilter
Declared inKSYGPUFilter.h
- - -
- -

Overview

-

KSY的滤镜基类

- -
    -
  1. 继承自GPUImageFilter的基本类
    2. -
  2. 添加了重新载入shader的接口
    3. -
- -
- - - -
- - - - - - -
-
- -

– init -

- -
-
- -
- - -
-

构造

-
- - - -
- (instancetype)init
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUFilter.h

-
- - -
-
-
- -

– reload: -

- -
-
- -
- - -
-

重新载入纹理shader的代码

-
- - - -
- (void)reload:(NSString *)fragmentShaderString
- - - -
-

Parameters

- - - - - - - -
fragmentShaderString

新的纹理shader的代码

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUFilter.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicInput.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicInput.html index 3b6240a..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicInput.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicInput.html @@ -3,11 +3,11 @@ - KSYGPUPicInput Class Reference + - +
@@ -43,50 +43,10 @@

@@ -99,580 +59,15 @@

-

KSYGPUPicInput Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageOutput
Declared inKSYGPUPicInput.h
- - -
- -

Overview

-

GPU图像输输入

- -
    -
  • 将采集到的YUV/RGB数据上传到GPU, 传递给其他filter进行处理
    • -
  • 支持的颜色格式包括: - -
      -
    • kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange: (NV12)
      • -
    • kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:(NV12)
      • -
    • kCVPixelFormatType_420YpCbCr8Planar:(I420)
      • -
    • kCVPixelFormatType_420YpCbCr8PlanarFullRange:(I420)
      • -
    • kCVPixelFormatType_32BGRA:(BGRA)
      • -
    -
    • -
  • 支持图像裁剪
    • -
  • 支持图像旋转
    • -
- -
- - - -
- - - - - - -
-
- -

– init -

- -
-
- -
- - -
-

Initialization and teardown

-
- - - -
- (id)init
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

– initWithFmt: -

- -
-
- -
- - -
-

设置输入图像的像素格式

-
- - - -
- (id)initWithFmt:(OSType)fmt
- - - -
-

Parameters

- - - - - - - -
fmt

像素格式

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

  cropRegion -

- -
-
- -
- - -
-

裁剪区域 将输入的图像按照区域裁剪出中间的一块

-
- - - -
@property (readwrite, nonatomic) CGRect cropRegion
- - - - - - - - - -
-

Discussion

-

cropRegion 标记了左上角的位置和宽高, 范围都是0.0 到1.0, 非法值无法设置成功

-
- - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

– forceProcessingAtSize: -

- -
-
- -
- - -
-

输出图像的尺寸

-
- - - -
- (void)forceProcessingAtSize:(CGSize)frameSize
- - - - - - - - - -
-

Discussion

-

设置了裁剪区域, 并且改变了宽高比后, 需要调用此接口, 否则图像可能变形

-
- - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

  outputSize -

- -
-
- -
- - -
-

实际输出图像的尺寸

-
- - - -
@property (nonatomic) CGSize outputSize
- - - - - - - - - -
-

Discussion

-

forceProcessingAtSize: 也是对outputSize属性进行赋值

-
- - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

  outputRotation -

- -
-
- -
- - -
-

输出画面的朝向

-
- - - -
@property (nonatomic, assign) GPUImageRotationMode outputRotation
- - - - - - - - - -
-

Discussion

-

输出的画面旋转90度的整数倍, 默认为 kGPUImageNoRotation

直接连接到KSYGPUPicMixer时, 旋转90度的情况可能出现问题, 请尽量保证中间有其他滤镜

-
- - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

  alwaysDiscardsLateVideoFrames -

- -
-
- -
- - -
-

是否允许超时丢帧

-
- - - -
@property (nonatomic, assign) BOOL alwaysDiscardsLateVideoFrames
- - - - - - - - - -
-

Discussion

-

当video frame处理超时时，该属性为YES时，将丢弃新的video frame，为NO时将等待处理完毕的信号。

默认为YES。

-
- - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

– processSampleBuffer: -

- -
-
- -
- - -
-

输入图像数据

-
- - - -
- (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

图像数据和时间信息

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

– processPixelBuffer:time: -

- -
-
- -
- - -
-

输入图像数据

-
- - - -
- (void)processPixelBuffer:(CVPixelBufferRef)pixelBuffer time:(CMTime)timeInfo
- - - -
-

Parameters

- - - - - - - - - - - - -
pixelBuffer

图像数据

timeInfo

时间信息

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
- -

– processPixelData:format:width:height:stride:time: -

- -
-
- -
- - -
-

输入图像数据

-
- - - -
- (void)processPixelData:(void **)pData format:(OSType)pixelFmt width:(size_t)width height:(size_t)height stride:(size_t *)strides time:(CMTime)timeInfo
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
pData

图像数据每个分量的指针, 比如pData[0]为Y分量的指针

pixelFmt

图像数据类型, 必须与init时指定的格式一致

width

图像宽度

height

图像高度

strides

图像数据每个分量的行偏移, 比如 stride[0] 为Y分量的行偏移

timeInfo

时间信息

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicInput.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicMixer.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicMixer.html index f38321b..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicMixer.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicMixer.html @@ -3,11 +3,11 @@ - KSYGPUPicMixer Class Reference + - +
@@ -43,50 +43,10 @@

@@ -99,627 +59,15 @@

-

KSYGPUPicMixer Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageFilter
Declared inKSYGPUPicMixer.h
- - -
- -

Overview

-

图像混合filter

- -
    -
  • 将多个图层的内容进行叠加
    • -
  • 每个图层有index, [0~n]
    • -
  • 叠加顺序为0在最下层, index 越大在更上层
    • -
  • 可以每个图层分别指定位置和大小
    • -
  • 可以每个图层分别制定透明度
    • -
  • 可以动态交换图层
    • -
  • 可以动态刷新图层内容(支持视频)
    • -
  • 输出的刷新率 与 masterLayer 保持一致
    • -
- -
- - - - - -
- - - - - - -
-
- -

– init -

- -
-
- -
- - -
-

初始化

-
- - - -
- (id)init
- - - - - - - - - -
-

Discussion

-

输出大小等于主要图层的大小

-
- - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– initWithOutputSize: -

- -
-
- -
- - -
-

初始化,并制定输出图像的大小

-
- - - -
- (id)initWithOutputSize:(CGSize)sz
- - - -
-

Parameters

- - - - - - - -
sz

输出图像的大小

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

  masterLayer -

- -
-
- -
- - -
-

设置主要图层 (默认为0)

-
- - - -
@property (nonatomic, assign) NSUInteger masterLayer
- - - - - - - - - -
-

Discussion

-

主要图层一般为视频图层, 当主要图层的输入刷新时, 输出才刷新

-
- - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– setPicRect:ofLayer: -

- -
-
- -
- - -
-

设置图层的位置和大小 (单位为: 像素值 或者百分比)

-
- - - -
- (void)setPicRect:(CGRect)rect ofLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - - - - - - -
rect

大小和位置

idx

图层的索引

-
- - - - - - - -
-

Discussion

-

缩放变形到对应的位置, 数值有如下两种表示方式 - - 像素值:rect中宽度或高度的值必须大于1.0, 则认为是像素值 - - 百分比:rect中宽度或高度的值必须小于等于1.0, 则认为是对应输出图像大小的百分比

保持宽高比的设置方法 - - 宽为0, 则按照高度和输入图像的宽高比计算出宽度 - - 高为0, 则按照宽度和输入图像的宽高比计算出高度

左上角的位置如果为非负值,则和宽高一样;如果为负数, 则自动居中放置

-
- - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– getPicRectOfLayer: -

- -
-
- -
- - -
-

获取图层的位置和大小 (单位为: 像素值 或者百分比)

-
- - - -
- (CGRect)getPicRectOfLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

图层的索引

-
- - - -
-

Return Value

-

位置和大小

-
- - - - - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– setPicAlpha:ofLayer: -

- -
-
- -
- - -
-

设置图层的透明度 (默认为1.0)

-
- - - -
- (void)setPicAlpha:(CGFloat)alpha ofLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - - - - - - -
alpha

透明度(0~1.0), 0为全透明

idx

图层的索引

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– getPicAlphaOfLayer: -

- -
-
- -
- - -
-

获取图层的透明度

-
- - - -
- (CGFloat)getPicAlphaOfLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

图层的索引

-
- - - -
-

Return Value

-

透明度

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– setPicRotation:ofLayer: -

- -
-
- -
- - -
-

设置图层的旋转 (默认为norotation)

-
- - - -
- (void)setPicRotation:(GPUImageRotationMode)rotation ofLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - - - - - - -
rotation

透明度(0~1.0), 0为全透明

idx

图层的索引

-
- - - - - - - -
-

Discussion

-

可用于设置镜像 (kGPUImageFlipHorizonal)

-
- - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– getPicRotationOfLayer: -

- -
-
- -
- - -
-

获取图层的旋转模式

-
- - - -
- (GPUImageRotationMode)getPicRotationOfLayer:(NSInteger)idx
- - - -
-

Parameters

- - - - - - - -
idx

图层的索引

-
- - - -
-

Return Value

-

旋转模式

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
- -

– clearPicOfLayer: -

- -
-
- -
- - -
-

清除特定图层的画面内容

-
- - - -
- (void)clearPicOfLayer:(NSInteger)index
- - - -
-

Parameters

- - - - - - - -
index

指定被清除的图层

-
- - - - - - - -
-

Discussion

-

比如切换不同的视频内容时，避免出现黑色背景

-
- - - - - - - -
-

Declared In

-

KSYGPUPicMixer.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicOutput.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicOutput.html index 2555689..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicOutput.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPicOutput.html @@ -3,11 +3,11 @@ - KSYGPUPicOutput Class Reference + - +
@@ -43,54 +43,10 @@

@@ -103,641 +59,15 @@

-

KSYGPUPicOutput Class Reference

+

-
- - - - - - - - - - -
Inherits fromNSObject
Conforms toGPUImageInput
Declared inKSYGPUPicOutput.h
- - -
- -

Overview

-

GPU图像输出

- -

从GPU中取得处理后的图像, 通过回调函数将pixelBuffer和时间戳送出

- -
    -
  • 本模块含有一个GPUImageInput的接口, 从其他filter接收渲染结果
    • -
  • 通过inputSize 查询输入的图像尺寸
    • -
  • 通过outputSize 设置输出的图像尺寸
    • -
  • 通过cropRegion 设置裁剪区域
    • -
  • 初始化时可指定输出数据的像素格式
    • -
  • 支持的输出颜色格式包括: - -
      -
    • kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange: (NV12)
      • -
    • kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:(NV12)
      • -
    • kCVPixelFormatType_420YpCbCr8Planar:(I420)
      • -
    • kCVPixelFormatType_420YpCbCr8PlanarFullRange:(I420)
      • -
    • kCVPixelFormatType_32BGRA:(BGRA)
      • -
    • kCVPixelFormatType_4444AYpCbCr8:(AYUV) 排列顺序为 (A Y' Cb Cr)
      • -
    -
    • -
-
- - - - - -
- - - - -

Initialization

- -
-
- -

– init -

- -
-
- -
- - -
-

初始化方法

-
- - - -
- (id)init
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

– initWithOutFmt: -

- -
-
- -
- - -
-

指定输出格式的初始化

-
- - - -
- (id)initWithOutFmt:(OSType)fmt
- - - -
-

Parameters

- - - - - - - -
fmt

输出格式

-
- - - - - - - - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
-
- - - -

query and settings

- -
-
- -

  outputPixelFormat -

- -
-
- -
- - -
-

output format (默认:kCVPixelFormatType_32BGRA)

-
- - - -
@property (nonatomic, readonly) OSType outputPixelFormat
- - - - - - - - - -
-

Discussion

-

非法颜色格式都会被当做 kCVPixelFormatType_32BGRA 处理

-
- - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  enabled -

- -
-
- -
- - -
-

GPUImageInput - (BOOL)enabled;

-
- - - -
@property (nonatomic) BOOL enabled
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  bCustomOutputSize -

- -
-
- -
- - -
-

是否使用自定义输出尺寸 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL bCustomOutputSize
- - - - - - - - - -
-

Discussion

-

NO: outputSize自动跟随输入图像的变化而变化

YES: outputSize使用外部自定义设置,忽略输入尺寸

-
- - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  outputSize -

- -
-
- -
- - -
-

output picture size

-
- - - -
@property (nonatomic, assign) CGSize outputSize
- - - - - - - - - -
-

Discussion

-

当bCustomOutputSize设置为NO时,outputSize无法被修改

可以对裁剪后的图像再进行缩放

输出尺寸必须为4的整数倍, 内部会进行向上取整

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  cropRegion -

- -
-
- -
- - -
-

裁剪区域 将输入的图像按照区域裁剪出中间的一块

-
- - - -
@property (readwrite, nonatomic) CGRect cropRegion
- - - - - - - - - -
-

Discussion

-

cropRegion 标记了左上角的位置和宽高, 范围都是0.0 到1.0

-
- - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  inputSize -

- -
-
- -
- - -
-

input picture size

-
- - - -
@property (nonatomic, readonly) CGSize inputSize
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  bAutoRepeat -

- -
-
- -
- - -
-

是否冻结图像(主动提供重复图像)

-
- - - -
@property (nonatomic, readwrite) BOOL bAutoRepeat
- - - - - - - - - -
-

Discussion

-

比如:视频采集被打断时, bAutoRepeat为NO,则停止提供图像; 为YES, 则主动提供最后一帧图像

-
- - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  targetFps -

- -
-
- -
- - -
-

0表示根据过去输入的图像来猜测帧率, 1~30 表示按照设定的帧率提供重复的帧, 默认为0

-
- - - -
@property (nonatomic, readwrite) int targetFps
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

– getInputRotation -

- -
-
- -
- - -
-

input roation mode

-
- - - -
- (GPUImageRotationMode)getInputRotation
- - - - - -
-

Return Value

-

图像的旋转模式

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
- -

  videoProcessingCallback -

- -
-
- -
- - -
-

视频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CVPixelBufferRef pixelBuffer , CMTime timeInfo ) videoProcessingCallback
- - - - - - - - - -
-

Discussion

-

pixelBuffer 美颜处理后，编码之前的视频数据

timeInfo 时间戳 -@warnning 请注意本函数的执行时间，如果太长可能导致不可预知的问题

-
- - - - - - - -
-

Declared In

-

KSYGPUPicOutput.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPipStreamerKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPipStreamerKit.html index 5c1924f..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPipStreamerKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUPipStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUPipStreamerKit Class Reference + - +
@@ -45,54 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -105,651 +59,15 @@

-

KSYGPUPipStreamerKit Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUStreamerKit : NSObject
Declared inKSYGPUPipStreamerKit.h
- - -
- - - - - - -
-
- -

  pipTrack -

- -
-
- -
- - -
-

画中画通道

-
- - -
@property (nonatomic, readonly) int pipTrack
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  bgPicLayer -

- -
-
- -
- - -
-

背景图片图层

-
- - - -
@property (nonatomic, readonly) NSInteger bgPicLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  pipLayer -

- -
-
- -
- - -
-

画中画图层

-
- - - -
@property (nonatomic, readonly) NSInteger pipLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

– startPipWithPlayerUrl:bgPic: -

- -
-
- -
- - -
-

开启画中画 -@param playerUrl:播放视频的url -@param bgUrl:背景图片的url

-
- - - -
- (void)startPipWithPlayerUrl:(NSURL *_Nullable)playerUrl bgPic:(NSURL *_Nullable)bgUrl
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

– stopPip -

- -
-
- -
- - -
-

停止画中画 -*

-
- - - -
- (void)stopPip
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  player -

- -
-
- -
- - -
-

背景播放器

-
- - - -
@property (nonatomic, readonly) KSYMoviePlayerController *player
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  bgPic -

- -
-
- -
- - -
-

背景图片

-
- - - -
@property (nonatomic, strong) GPUImagePicture *bgPic
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  yuvInput -

- -
-
- -
- - -
-

画中画图像输入

-
- - - -
@property (nonatomic, readonly) KSYGPUPicInput *yuvInput
- - - - - - - - - -
-

Discussion

-

用于衔接画中画播放器和图像混合器 (KSYPicPipLayer = 1)

主要用于将图像的原始数据上传到GPU

-
- - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  bgPicRect -

- -
-
- -
- - -
-

背景图片的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect bgPicRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  pipRect -

- -
-
- -
- - -
-

画中画的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect pipRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  cameraRect -

- -
-
- -
- - -
-

相机的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect cameraRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

– getPipStateName: -

- -
-
- -
- - -
-

获取状态对应的字符串

-
- - - -
- (NSString *_Nonnull)getPipStateName:(MPMoviePlaybackState)stat
- - - -
-

Parameters

- - - - - - - -
stat

状态

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

– getCurPipStateName -

- -
-
- -
- - -
-

获取当前状态对应的字符串

-
- - - -
- (NSString *_Nonnull)getCurPipStateName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
- -

  PipState -

- -
-
- -
- - -
-

播放状态

-
- - - -
@property (nonatomic, readonly) MPMoviePlaybackState PipState
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUPipStreamerKit.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUStreamerKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUStreamerKit.html index 93cd0ea..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUStreamerKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUStreamerKit Class Reference + - +
@@ -43,182 +43,10 @@

@@ -231,3662 +59,23 @@

-

KSYGPUStreamerKit Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYGPUStreamerKit.h
- - -
- -

Overview

-

KSY 直播推流工具类

- -
    -
  • kit类将直播推流SDK中提供的各种组件进行组合串联, 功能覆盖了绝大部分秀场直播场景的需求
    • -
  • 可以直接使用Kit类来开发基础功能的推流APP
    • -

  • 亦可以参考kit类的代码, 了解每个组件API的使用方法, 自行开发进阶需求的功能

    • -

  • 本 kit 类中, 演示了3个图层内容和2个音频通道的叠加直播

    • -

  • 图像通道: ([]中的数字为图层编号) -vCapDev –> cropFilter –> filters[0] –>| vPreMixer |-> preview - logo picture[1] –>| - logo text label[2] –>| vStrMixer |-> picOutput –> streamer

    • -

  • 音频通道: ([]中的数字为音轨编号) - aCapDev [0] –>| -bgmplayer [1] –>| aMixer –> streamer

    • -
-
- - - -
- - + +
- - - -
-
- -

– initWithDefaultCfg -

- -
-
- -
- - -
-

初始化方法

-
- - - -
- (instancetype)initWithDefaultCfg
- - - - - - - - - -
-

Discussion

-

创建带有默认参数的 kit，不会打断其他后台的音乐播放

Warning: kit只支持单实例推流，构造多个实例会出现异常

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– initWithInterruptCfg -

- -
-
- -
- - -
-

初始化方法

-
- - - -
- (instancetype)initWithInterruptCfg
- - - - - - - - - -
-

Discussion

-

创建带有默认参数的 kit，会打断其他后台的音乐播放

Warning: kit只支持单实例推流，构造多个实例会出现异常

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– getKSYVersion -

- -
-
- -
- - -
-

获取SDK版本号

-
- - - -
- (NSString *)getKSYVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  vCapDev -

- -
-
- -
- - -
-

视频采集设备

-
- - - -
@property (nonatomic, readonly) KSYAVFCapture *vCapDev
- - - - - - - - - -
-

Discussion

-

通过该指针可以对摄像头进行操作 (操作接口参见GPUImage)

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  filter -

- -
-
- -
- - -
-

获取当前使用的滤镜

-
- - - -
@property (nonatomic, readonly) GPUImageOutput<GPUImageInput> *filter
- - - - - - - - - -
-

Discussion

-

通过此指针可以对滤镜参数进行设置 -@waning 请确保外部保留了filter的真实类型的指针, 否则会出现奔溃

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  vPreviewMixer -

- -
-
- -
- - -
-

图像混合器 for 预览

-
- - - -
@property (nonatomic, readonly) KSYGPUPicMixer *vPreviewMixer
- - - - - - - - - -
-

Discussion

-

将多图层的内容叠加

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  vStreamMixer -

- -
-
- -
- - -
-

图像混合器 for 推流

-
- - - -
@property (nonatomic, readonly) KSYGPUPicMixer *vStreamMixer
- - - - - - - - - -
-

Discussion

-

将多图层的内容叠加

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  preview -

- -
-
- -
- - -
-

预览视图

-
- - - -
@property (nonatomic, readonly) KSYGPUView *preview
- - - - - - - - - -
-

Discussion

-

通过此指针可以对预览视图进行操作

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  capToGpu -

- -
-
- -
- - -
-

采集到的图像上传GPU

-
- - - -
@property (nonatomic, readonly) KSYGPUPicInput *capToGpu
- - - - - - - - - -
-

Discussion

-

用于衔接GPU和capture

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  gpuToStr -

- -
-
- -
- - -
-

获取渲染的图像

-
- - - -
@property (nonatomic, readonly) KSYGPUPicOutput *gpuToStr
- - - - - - - - - -
-

Discussion

-

用于衔接GPU和streamer

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  aCapDev -

- -
-
- -
- - -
-

音频采集设备 Audio Unit 音频采集

-
- - - -
@property (nonatomic, readonly) KSYAUAudioCapture *aCapDev
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  bgmPlayer -

- -
-
- -
- - -
-

背景音乐播放器

-
- - - -
@property (nonatomic, readonly) KSYBgmPlayer *bgmPlayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  aMixer -

- -
-
- -
- - -
-

音频混合器

-
- - - -
@property (nonatomic, readonly) KSYAudioMixer *aMixer
- - - - - - - - - -
-

Discussion

-

用于将多路音频进行混合,将混合后的音频送入streamerBase

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  audioCaptureType -

- -
-
- -
- - -
-

音频采集模式

-
- - - -
@property (nonatomic, assign) KSYAudioCapType audioCaptureType
- - - - - - - - - -
-

Discussion

-

推荐使用AudioUnit模式

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  msgStreamer -

- -
-
- -
- - -
-

消息通道

-
- - - -
@property (nonatomic, readonly) KSYMessage *msgStreamer
- - - - - - - - - -
-

Discussion

-

用于采集消息，并将数据送入streamerBase

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamerBase -

- -
-
- -
- - -
-

获取初始化时创建的底层推流工具

-
- - - -
@property (nonatomic, readonly) KSYStreamerBase *streamerBase
- - - - - - - - - -
-

Discussion

-
    -
  1. 通过它来设置推流参数
    2. -
-
    -
  1. 通过它来启动，停止推流
    2. -
- -
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  maxAutoRetry -

- -
-
- -
- - -
-

自动重连次数 关闭(0), 开启(>0), 默认为0

-
- - - -
@property (nonatomic, assign) int maxAutoRetry
- - - - - - - - - -
-

Discussion

-

当内部发现推流错误后, 会在一段时间后尝试重连 -自动重连不会重新获取推流地址, 仍然使用上次推流的地址

Warning: 如果在推流地址有过期时间, 请勿开启

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  autoRetryDelay -

- -
-
- -
- - -
-

自动重连延时, 发现连接错误后, 重试的延时

-
- - - -
@property (nonatomic, assign) double autoRetryDelay
- - - - - - - - - -
-

Discussion

-

单位为秒, 默认为2s, 最小值为0.1s

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  cameraLayer -

- -
-
- -
- - -
-

摄像头图层

-
- - - -
@property (nonatomic, readonly) NSInteger cameraLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  logoPicLayer -

- -
-
- -
- - -
-

logo 图片的图层

-
- - - -
@property (nonatomic, readonly) NSInteger logoPicLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  logoTxtLayer -

- -
-
- -
- - -
-

logo 文字的图层

-
- - - -
@property (nonatomic, readonly) NSInteger logoTxtLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  aeLayer -

- -
-
- -
- - -
-

贴纸的图层

-
- - - -
@property (nonatomic, readonly) NSInteger aeLayer
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  micTrack -

- -
-
- -
- - -
-

麦克风通道

-
- - - -
@property (nonatomic, readonly) int micTrack
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  bgmTrack -

- -
-
- -
- - -
-

背景音乐通道

-
- - - -
@property (nonatomic, readonly) int bgmTrack
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  captureState -

- -
-
- -
- - -
-

当前采集设备状况

-
- - - -
@property (nonatomic, readonly) KSYCaptureState captureState
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取采集设备的工作状况

通知： -* KSYCaptureStateDidChangeNotification 当采集设备工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– getCaptureStateName: -

- -
-
- -
- - -
-

获取采集状态对应的字符串

-
- - - -
- (NSString *)getCaptureStateName:(KSYCaptureState)stat
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– getCurCaptureStateName -

- -
-
- -
- - -
-

获取当前采集状态对应的字符串

-
- - - -
- (NSString *)getCurCaptureStateName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– startPreview: -

- -
-
- -
- - -
-

启动预览

-
- - - -
- (void)startPreview:(UIView *)view
- - - -
-

Parameters

- - - - - - - -
view

预览画面作为subview，插入到 view 的最底层

-
- - - - - - - -
-

Discussion

-

设置完成采集参数之后，按照设置值启动预览，启动后对采集参数修改不会生效

需要访问摄像头和麦克风的权限，若授权失败，其他API都会拒绝服务

- -

@warning: 开始推流前必须先启动预览

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– startVideoCap -

- -
-
- -
- - -
-

开启视频配置和采集

-
- - - -
- (BOOL)startVideoCap
- - - - - - - - - -
-

Discussion

-

设置完成视频采集参数之后，按照设置值启动视频预览，启动后对视频采集参数修改不会生效

需要访问摄像头的权限，若授权失败，其他API都会拒绝服务

视频采集成功返回YES，不成功返回NO

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– startAudioCap -

- -
-
- -
- - -
-

开始音频配置和采集

-
- - - -
- (BOOL)startAudioCap
- - - - - - - - - -
-

Discussion

-

设置完成音频采集参数之后，按照设置值启动音频预览，启动后对音频采集参数修改不会生效

需要访问麦克风的权限，若授权失败，其他API都会拒绝服务

音频采集成功返回YES，不成功返回NO

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– stopPreview -

- -
-
- -
- - -
-

停止预览，停止采集设备，并清理会话

-
- - - -
- (void)stopPreview
- - - - - - - - - -
-

Discussion

-

若推流未结束，则先停止推流

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– appEnterBackground -

- -
-
- -
- - -
-

进入后台: 暂停图像采集

-
- - - -
- (void)appEnterBackground
- - - - - - - - - -
-

Discussion

-

暂停图像采集和预览, 中断旁路录制

如果需要释放mic资源请直接调用停止采集

kit内部在收到UIApplicationDidEnterBackgroundNotification 或采集被打断等事件时,会主动调用本接口

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– appBecomeActive -

- -
-
- -
- - -
-

回到前台: 恢复采集

-
- - - -
- (void)appBecomeActive
- - - - - - - - - -
-

Discussion

-

恢复图像采集和预览

恢复音频采集

kit内部在收到UIApplicationDidBecomeActiveNotification等事件时,会主动调用本接口

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  capPreset -

- -
-
- -
- - -
-

采集分辨率 (仅在开始采集前设置有效)

-
- - - -
@property (nonatomic, assign) NSString *capPreset
- - - - - - - - - -
-

Discussion

-

参见iOS的 AVCaptureSessionPresetXXX的定义

https://developer.apple.com/reference/avfoundation/avcapturesession/1669314-video_input_presets?language=objc

透传到 KSYGPUCamera. 默认值为AVCaptureSessionPreset640x480

不同设备支持的预设分辨率可能不同, 请尽量与预览分辨率一致

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– captureDimension -

- -
-
- -
- - -
-

查询实际的采集分辨率

-
- - - -
- (CGSize)captureDimension
- - - - - - - - - -
-

Discussion

-

参见iOS的 AVCaptureSessionPresetXXX的定义

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  previewDimension -

- -
-
- -
- - -
-

预览分辨率 (仅在开始采集前设置有效)

-
- - - -
@property (nonatomic, assign) CGSize previewDimension
- - - - - - - - - -
-

Discussion

-

内部始终将较大的值作为宽度 (若需要竖屏，请设置 videoOrientation）

宽高都会向上取整为4的整数倍

有效范围: 宽度[160, 1920] 高度[ 90, 1080], 超出范围会取边界有效值

当预览分辨率与采集分辨率不一致时: - 若宽高比不同, 先进行裁剪, 再进行缩放 - 若宽高比相同, 直接进行缩放

默认值为(640, 360)

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamDimension -

- -
-
- -
- - -
-

用户定义的视频 推流 分辨率

-
- - - -
@property (nonatomic, assign) CGSize streamDimension
- - - - - - - - - -
-

Discussion

-

有效范围: 宽度[160, 1280] 高度[ 90, 720], 超出范围会取边界有效值

其他与previewDimension限定一致,

当与previewDimension不一致时, 同样先裁剪到相同宽高比, 再进行缩放

默认值为(640, 360)

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  capturePixelFormat -

- -
-
- -
- - -
-

采集模块输出的像素格式 (默认:kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange)

-
- - - -
@property (nonatomic, assign) OSType capturePixelFormat
- - - - - - - - - -
-

Discussion

-

目前只支持 kCVPixelFormatType_32BGRA 和 kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange

仅在开始推流前设置有效

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  gpuOutputPixelFormat -

- -
-
- -
- - -
-

gpu output pixel format (默认:kCVPixelFormatType_32BGRA)

-
- - - -
@property (nonatomic, assign) OSType gpuOutputPixelFormat
- - - - - - - - - -
-

Discussion

-

目前支持 BGRA , NV12 和 I420

仅在开始推流前设置有效

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  videoFPS -

- -
-
- -
- - -
-

采集及编码视频帧率 (开始采集前设置有效)

-
- - - -
@property (nonatomic, assign) int videoFPS
- - - - - - - - - -
-

Discussion

-

video frame per seconds 有效范围[1~30], 超出范围会取边界有效值

默认值为15

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  cameraPosition -

- -
-
- -
- - -
-

摄像头位置 (仅在开始采集前设置有效)

-
- - - -
@property (nonatomic, assign) AVCaptureDevicePosition cameraPosition
- - - - - - - - - -
-

Discussion

-

前后摄像头, 默认值为前置

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  videoOrientation -

- -
-
- -
- - -
-

摄像头朝向, 只在启动采集前设置有效

-
- - - -
@property (nonatomic, readwrite) UIInterfaceOrientation videoOrientation
- - - - - - - - - -
-

Discussion

-

参见UIInterfaceOrientation

竖屏时: width < height

横屏时: width > height

需要与UI方向一致

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  bStereoAudioStream -

- -
-
- -
- - -
-

是否用双声道推流 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL bStereoAudioStream
- - - - - - - - - -
-

Discussion

-

使用KSYAUAudioCapture采集的声音目前只支持单声道(主播说话的声音为单声道)

背景音乐如果是双声道的音频,通过修改bStereoStream, 可以让观众听到双声道的音乐

只能在开始推流前修改本属性, 开始推流后, 修改无效

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– switchCamera -

- -
-
- -
- - -
-

切换摄像头

-
- - - -
- (BOOL)switchCamera
- - - - - -
-

Return Value

-

TRUE: 成功切换摄像头， FALSE：当前参数，下一个摄像头不支持，切换失败

-
- - - - - -
-

Discussion

-

在前后摄像头间切换，从当前的摄像头切换到另一个，切换成功则修改cameraPosition的值

开始预览后开始有效，推流过程中也响应切换请求

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– isTorchSupported -

- -
-
- -
- - -
-

当前采集设备是否支持闪光灯

-
- - - -
- (BOOL)isTorchSupported
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - -
-

Discussion

-

通常只有后置摄像头支持闪光灯

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– toggleTorch -

- -
-
- -
- - -
-

开关闪光灯

-
- - - -
- (void)toggleTorch
- - - - - - - - - -
-

Discussion

-

切换闪光灯的开关状态 开 <–> 关

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– setTorchMode: -

- -
-
- -
- - -
-

设置闪光灯

-
- - - -
- (void)setTorchMode:(AVCaptureTorchMode)mode
- - - -
-

Parameters

- - - - - - - -
mode

AVCaptureTorchModeOn/Off

-
- - - - - - - -
-

Discussion

-

设置闪光灯的开关状态

开始预览后开始有效

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– getCurrentCameraDevices -

- -
-
- -
- - -
-

获取当前采集设备的指针

-
- - - -
- (AVCaptureDevice *)getCurrentCameraDevices
- - - - - -
-

Return Value

-

AVCaptureDevice* 预览开始前调用返回为nil，开始预览后，返回当前正在使用的摄像头

-
- - - - - -
-

Discussion

-

开放本指针的目的是开放类似下列添加到AVCaptureDevice的 categories： -- AVCaptureDeviceFlash -- AVCaptureDeviceTorch -- AVCaptureDeviceFocus -- AVCaptureDeviceExposure -- AVCaptureDeviceWhiteBalance -- etc.

Warning: 请勿修改摄像头的像素格式，帧率，分辨率等参数，修改后会导致推流工作异常或崩溃

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  videoProcessingCallback -

- -
-
- -
- - -
-

视频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

原始采集到的视频数据

-
- - - - - - - -
-

Discussion

-

对sampleBuffer内的图像数据的修改将传递到观众端

请注意本函数的执行时间，如果太长可能导致不可预知的问题

请参考 CMSampleBufferRef

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  audioProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
- - - - - - - - - -
-

Discussion

-

sampleBuffer 原始采集到的音频数据

对sampleBuffer内的pcm数据的修改将传递到观众端

请注意本函数的执行时间，如果太长可能导致不可预知的问题

当audioDataType 为KSYAudioData_CMSampleBuffer时才会被触发回调

请参考 CMSampleBufferRef

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  pcmProcessingCallback -

- -
-
- -
- - -
-

音频处理回调接口

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime timeInfo ) pcmProcessingCallback
- - - - - - - - - -
-

Discussion

-

pData len为原始采集到的音频数据

当audioDataType 为KSYAudioData_RawPCM时才会被触发回调

请注意本函数的执行时间，如果太长可能导致不可预知的问题

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  audioDataType -

- -
-
- -
- - -
-

音频处理通路数据类型 (默认为 KSYAudioData_CMSampleBuffer)

-
- - - -
@property (nonatomic, assign) KSYAudioDataType audioDataType
- - - - - - - - - -
-

Discussion

-

音频数据转为 CMSampleBuffer时有格式开销, 使用RawPCM资源消耗会少一些

内部组件对KSYAudioData_RawPCM可能不完善, 目前仅保证基本通路能工作

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  interruptCallback -

- -
-
- -
- - -
-

摄像头采集被打断的消息通知

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( BOOL bInterrupt ) interruptCallback
- - - - - - - - - -
-

Discussion

-

bInterrupt 为YES, 表明被打断, 摄像头采集暂停

bInterrupt 为NO, 表明恢复采集

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– setupFilter: -

- -
-
- -
- - -
-

设置当前使用的滤镜

-
- - - -
- (void)setupFilter:(GPUImageOutput<GPUImageInput> *)filter
- - - - - - - - - -
-

Discussion

-

若filter 为nil， 则关闭滤镜

若filter 为GPUImageFilter的实例，则使用该滤镜做处理

filter 也可以是GPUImageFilterGroup的实例，可以将多个滤镜组合

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  previewMirrored -

- -
-
- -
- - -
-

预览设置成镜像模式，默认为NO

-
- - - -
@property (nonatomic, assign) BOOL previewMirrored
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamerMirrored -

- -
-
- -
- - -
-

推流设置成镜像模式,默认为NO

-
- - - -
@property (nonatomic, assign) BOOL streamerMirrored
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamerFreezed -

- -
-
- -
- - -
-

推流的画面是否冻结 (默认为NO)

-
- - - -
@property (nonatomic, assign) BOOL streamerFreezed
- - - - - - - - - -
-

Discussion

-

通过本属性可以主动将推流的画面固定为当前帧

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  previewOrientation -

- -
-
- -
- - -
-

预览图像朝向, 如果UI能够旋转,需要保持和UI的朝向一致

-
- - - -
@property (nonatomic, assign) UIInterfaceOrientation previewOrientation
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamOrientation -

- -
-
- -
- - -
-

推流图像朝向, 如果UI能够旋转, 可以跟随旋转,也可以不修改

-
- - - -
@property (nonatomic, assign) UIInterfaceOrientation streamOrientation
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– rotatePreviewTo: -

- -
-
- -
- - -
-

根据UI的朝向旋转预览视图, 保证预览视图全屏铺满窗口

-
- - - -
- (void)rotatePreviewTo:(UIInterfaceOrientation)orie
- - - -
-

Parameters

- - - - - - - -
orie

旋转到目标朝向, 需要从demo中获取UI的朝向传入

-
- - - - - - - -
-

Discussion

-

采集到的图像的朝向还是和启动时的朝向一致

此函数与 previewOrientation的set函数功能一样

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– rotateStreamTo: -

- -
-
- -
- - -
-

根据UI的朝向旋转推流画面, 这个是可以选的,可以不跟随旋转

-
- - - -
- (void)rotateStreamTo:(UIInterfaceOrientation)orie
- - - -
-

Parameters

- - - - - - - -
orie

旋转到目标朝向, 需要从demo中获取UI的朝向传入

-
- - - - - - - -
-

Discussion

-

此函数与 streamOrientation 的set函数功能一样

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  logoPic -

- -
-
- -
- - -
-

水印logo的图片

-
- - - -
@property (nonatomic, readwrite) GPUImagePicture *logoPic
- - - - - - - - - -
-

Discussion

-

设置为nil为清除水印图片

请注意背景图片的尺寸, 太大的图片会导致内存占用过高

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– setLogoOrientaion: -

- -
-
- -
- - -
-

设置水印图片的朝向

-
- - - -
- (void)setLogoOrientaion:(UIImageOrientation)orien
- - - -
-

Parameters

- - - - - - - -
orien

图片的朝向

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  textPic -

- -
-
- -
- - -
-

文字内容的图片

-
- - - -
@property (nonatomic, readwrite) GPUImagePicture *textPic
- - - - - - - - - -
-

Discussion

-

设置为nil为清除内容图片

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  aePic -

- -
-
- -
- - -
-

贴纸的图片

-
- - - -
@property (nonatomic, readwrite) GPUImageUIElement *aePic
- - - - - - - - - -
-

Discussion

-

设置为nil为清除贴纸图片

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  logoRect -

- -
-
- -
- - -
-

水印logo的图片的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect logoRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  logoAlpha -

- -
-
- -
- - -
-

水印logo的图片的位置

-
- - - -
@property (nonatomic, readwrite) CGFloat logoAlpha
- - - - - - - - - -
-

Discussion

-

alpha为透明度(0-1),0完全透明，1完全不透明

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  textLabel -

- -
-
- -
- - -
-

水印文字的label

-
- - - -
@property (nonatomic, readwrite) UILabel *textLabel
- - - - - - - - - -
-

Discussion

-

借用UILabel来指定文字的颜色,字体, 透明度, 对齐方式等属性

请注意保证背景图片的尺寸, 太大的图片会导致内存占用过高

Warning: 如果使用非等宽字体, 可能导致闪烁(默认为Courier)

Warning: picMixer和UILabel都有alpha属性, 建议只选用其中一个, 固定另一个为1.0, - 为了减少接口, 建议直接使用UILabel的属性, - 如果两者同时使用, 最终图层的alpha为两者乘积

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  textRect -

- -
-
- -
- - -
-

水印文字的图片的位置和大小

-
- - - -
@property (nonatomic, readwrite) CGRect textRect
- - - - - - - - - -
-

Discussion

-

位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

如果宽为0, 则根据文字图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

如果高为0, 方法同上

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– updateTextLabel -

- -
-
- -
- - -
-

刷新水印文字的内容

-
- - - -
- (void)updateTextLabel
- - - - - - - - - -
-

Discussion

-

先修改文字的内容或格式,调用该方法后生效

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– focusAtPoint: -

- -
-
- -
- - -
-

当前采集设备是否支持自动变焦 -@param point相机对焦的位置

-
- - - -
- (BOOL)focusAtPoint:(CGPoint)point
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - -
-

Discussion

-

通常只有后置摄像头支持自动变焦

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– exposureAtPoint: -

- -
-
- -
- - -
-

当前采集设备是否支持自动曝光 -@param point相机曝光的位置

-
- - - -
- (BOOL)exposureAtPoint:(CGPoint)point
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - -
-

Discussion

-

通常前后置摄像头都支持自动曝光

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  pinchZoomFactor -

- -
-
- -
- - -
-

触摸缩放因子

-
- - - -
@property (nonatomic, assign) CGFloat pinchZoomFactor
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  streamerProfile -

- -
-
- -
- - -
-

采集和推流配置参数

-
- - - -
@property (nonatomic, assign) KSYStreamerProfile streamerProfile
- - - - - - - - - -
-

Discussion

-

选择profile类型后, 采集和编码参数会自动配置进去, 默认的profile类型是KSYStreamerProfile_540p_3

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

  stabilizationMode -

- -
-
- -
- - -
-

摄像头防抖模式，切换摄像头后需要进行重新设置

-
- - - -
@property (nonatomic, assign) AVCaptureVideoStabilizationMode stabilizationMode
- - - - - - - - - -
-

Discussion

-

(iPhone前置摄像头不支持防抖功能)

-
- - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
- -

– processMessageData: -

- -
-
- -
- - -
-

用户待发送的消息 -@param messageData待发送的消息

-
- - - -
- (BOOL)processMessageData:(NSDictionary *)messageData
- - - - - -
-

Return Value

-

YES / NO

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUStreamerKit.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUView.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUView.html index 8841655..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUView.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUView.html @@ -3,11 +3,11 @@ - KSYGPUView Class Reference + - +
@@ -43,40 +43,10 @@

@@ -89,285 +59,15 @@

-

KSYGPUView Class Reference

+

-
- - - - - - - - - - -
Inherits fromUIView
Conforms toGPUImageInput
Declared inKSYGPUView.h
- - -
- -

Overview

-

UIView subclass to use as an endpoint for displaying GPUImage outputs

-
- - - -
- - - - - - -
-
- -

  fillMode -

- -
-
- -
- - -
-

画面填充模式, 默认值为kGPUImageFillModePreserveAspectRatio

-
- - - -
@property (readwrite, nonatomic) GPUImageFillModeType fillMode
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUView.h

-
- - -
-
-
- -

  sizeInPixels -

- -
-
- -
- - -
-

This calculates the current display size, in pixels, taking into account Retina scaling factors

-
- - - -
@property (readonly, nonatomic) CGSize sizeInPixels
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUView.h

-
- - -
-
-
- -

  enabled -

- -
-
- -
- - -
-

GPUImageInput 启用

-
- - - -
@property (nonatomic) BOOL enabled
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUView.h

-
- - -
-
-
- -

– setBackgroundColorRed:green:blue:alpha: -

- -
-
- -
- - -
-

Handling fill mode

-
- - - -
- (void)setBackgroundColorRed:(GLfloat)redComponent green:(GLfloat)greenComponent blue:(GLfloat)blueComponent alpha:(GLfloat)alphaComponent
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - -
redComponent

Red component for background color

greenComponent

Green component for background color

blueComponent

Blue component for background color

alphaComponent

Alpha component for background color

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUView.h

-
- - -
-
-
- -

– setCurrentlyReceivingMonochromeInput: -

- -
-
- -
- - -
-

是否接收单通道输入

-
- - - -
- (void)setCurrentlyReceivingMonochromeInput:(BOOL)newValue
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUView.h

-
- - -
-
-
-
- -
- - - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUViewCapture.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUViewCapture.html index 71c3bdf..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUViewCapture.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUViewCapture.html @@ -3,11 +3,11 @@ - KSYGPUViewCapture Class Reference + - +
@@ -43,50 +43,10 @@

@@ -99,488 +59,15 @@

-

KSYGPUViewCapture Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageOutput
Declared inKSYGPUViewCapture.h
- - -
- -

Overview

-

GPU UIView视图 采集模块

- -
    -
  • 采集UIView视图的内容到GPU
    • -
  • 内部使用 CADisplayLink 作为timer 驱动画面更新
    • -
  • 可通过属性设置更新频率
    • -
-
- - - - - -
- - - - - - -
-
- -

– initWithView: -

- -
-
- -
- - -
-

设置需要采集的视图

-
- - - -
- (id)initWithView:(UIView *)inputView
- - - -
-

Parameters

- - - - - - - -
inputView

被采集的视图

-
- - - -
-

Return Value

-

采集实例

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– initWithLayer: -

- -
-
- -
- - -
-

设置需要采集的视图图层

-
- - - -
- (id)initWithLayer:(CALayer *)inputLayer
- - - -
-

Parameters

- - - - - - - -
inputLayer

被采集的图层

-
- - - -
-

Return Value

-

采集实例

-
- - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– layerSizeInPixels -

- -
-
- -
- - -
- (CGSize)layerSizeInPixels
- - -
-
-
- -

– update -

- -
-
- -
- - -
-

更新画面内容 使用无效时间戳

-
- - - -
- (void)update
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– updateUsingCurrentTime -

- -
-
- -
- - -
-

更新画面内容 使用当前时间戳

-
- - - -
- (void)updateUsingCurrentTime
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– updateWithTimestamp: -

- -
-
- -
- - -
-

更新画面内容

-
- - - -
- (void)updateWithTimestamp:(CMTime)frameTime
- - - -
-

Parameters

- - - - - - - -
frameTime

时间戳

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

  updateFps -

- -
-
- -
- - -
-

UI刷新的频率 默认值为15 (有效值fps=60/N, 比如60, 30, 20, 15, 10等)

-
- - - -
@property int updateFps
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– start -

- -
-
- -
- - -
-

启动采集

-
- - - -
- (void)start
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

– stop -

- -
-
- -
- - -
-

停止采集

-
- - - -
- (void)stop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
- -

  paused -

- -
-
- -
- - -
-

暂停 / 继续

-
- - - -
@property BOOL paused
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYGPUViewCapture.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUYUVInput.html b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUYUVInput.html index 7dbdbd3..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYGPUYUVInput.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYGPUYUVInput.html @@ -3,11 +3,11 @@ - KSYGPUYUVInput Class Reference + - +
@@ -43,20 +43,10 @@

@@ -69,38 +59,15 @@

-

KSYGPUYUVInput Class Reference

+

-
- - - - - - - -
Inherits fromKSYGPUPicInput : GPUImageOutput
Declared inKSYGPUPicInput.h
- - -
- -

Overview

-

GPU图像输输入 -过期的类, 请使用KSYGPUPicInput

-
- - - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfo.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfo.html index e7527bc..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfo.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfo.html @@ -3,11 +3,11 @@ - KSYMediaInfo Class Reference + - +
@@ -43,36 +43,10 @@

@@ -85,255 +59,15 @@

-

KSYMediaInfo Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYMediaInfo.h
- - -
- -

Overview

-

媒体信息

-
- - - - - -
- - - - - - -
-
- -

  type -

- -
-
- -
- - -
-

封装格式，具体类型为MEDIAINFO_MUX_TYPE

-
- - - -
@property (nonatomic) MEDIAINFO_MUX_TYPE type
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  bitrate -

- -
-
- -
- - -
-

码率

-
- - - -
@property (nonatomic, assign) int64_t bitrate
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  duration -

- -
-
- -
- - -
-

视频总时长，单位是秒

-
- - - -
@property (nonatomic, assign) NSTimeInterval duration
- - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  videos -

- -
-
- -
- - -
-

所有视频流信息，具体对象类型为KSYVideoInfo

-
- - - -
@property (nonatomic) NSMutableArray *videos
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  audios -

- -
-
- -
- - -
-

所有音频流信息，具体对象类型为KSYAudioInfo

-
- - - -
@property (nonatomic) NSMutableArray *audios
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfoProber.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfoProber.html index 6549700..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfoProber.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMediaInfoProber.html @@ -3,11 +3,11 @@ - KSYMediaInfoProber Class Reference + - +
@@ -43,52 +43,10 @@

@@ -101,617 +59,15 @@

-

KSYMediaInfoProber Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYMediaInfoProber.h
- - -
- -

Overview

-

KSYMediaInfoProber

-
- - - -
- - - - - - -
-
- -

– initWithContentURL: -

- -
-
- -
- - -
-

初始化文件格式探测器并设置播放地址

-
- - - -
- (instancetype)initWithContentURL:(NSURL *)url
- - - -
-

Parameters

- - - - - - - -
url

待探测格式的文件地址，该地址可以是本地地址或者服务器地址.

-
- - - -
-

Return Value

-

返回KSYMediaInfoProber对象

-
- - - - - -
-

Discussion

-

Warning: 必须调用该方法进行初始化，不能调用init方法。

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  timeout -

- -
-
- -
- - -
-

文件格式探测时间，单位是秒，默认值是3秒

-
- - - -
@property (nonatomic) NSTimeInterval timeout
- - - - - - - - - -
-

Discussion

-

超过该时间未探测到文件格式时，直接返回

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  bAccelerate -

- -
-
- -
- - -
-

是否要加速探测速度

-
- - - -
@property (nonatomic) BOOL bAccelerate
- - - - - - - - - -
-

Discussion

-

加速后，探测格式可能不完整，默认不加速

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

– setHttpHeaders: -

- -
-
- -
- - -
-

发送http请求时需要header带上的字段

-
- - - -
- (void)setHttpHeaders:(NSDictionary *)headers
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.0 and later.

-
- - - - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  url -

- -
-
- -
- - -
-

待探测的文件格式地址

-
- - - -
@property (nonatomic, copy) NSURL *url
- - - - - - - - - -
-

Discussion

-

可不释放KSYMediaInfoProber实例，通过设置contentURL来完成下一次探测

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  bH264Codec -

- -
-
- -
- - -
-

编码类型是否是h264

-
- - - -
@property (nonatomic, readonly) BOOL bH264Codec
- - - - - - - - - -
-

Discussion

-

获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  bHEVCCodec -

- -
-
- -
- - -
-

编码类型是否是hevc

-
- - - -
@property (nonatomic, readonly) BOOL bHEVCCodec
- - - - - - - - - -
-

Discussion

-

获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  bAACCodec -

- -
-
- -
- - -
-

编码类型是否是aac

-
- - - -
@property (nonatomic, readonly) BOOL bAACCodec
- - - - - - - - - -
-

Discussion

-

获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  bMP3Codec -

- -
-
- -
- - -
-

编码类型是否是mp3

-
- - - -
@property (nonatomic, readonly) BOOL bMP3Codec
- - - - - - - - - -
-

Discussion

-

获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

  ksyMediaInfo -

- -
-
- -
- - -
-

媒体信息, 具体对象类型为KSYMediaInfo

-
- - - -
@property (nonatomic, strong) KSYMediaInfo *ksyMediaInfo
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.3 and later.

-
- - - -
-

Discussion

-

未探测到文件格式时为nil

-
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
- -

– getVideoThumbnailImageAtTime:width:height: -

- -
-
- -
- - -
-

获取视频缩略图

-
- - - -
- (UIImage *)getVideoThumbnailImageAtTime:(NSTimeInterval)seekTime width:(int)width height:(int)height
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
seekTime

指定的时间位置，单位为s, 小于0时无法截图

width

缩略图的宽度

height

缩略图的高度

-
- - - -
-

Return Value

-

返回UIImage对象，即为缩略图

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 1.8.2 and later.

-
- - - -
-

Discussion

-

缩略图宽度和高度说明

- -
    -
  • 指定缩略图宽度和高度都为0时，输出的缩略图与原视频中的宽高相同
    • -
  • 指定缩略图宽度不为0，高度为0时，高度会根据原视频的宽高比例做出缩放
    • -
  • 指定缩略图高度不为0，宽度为0时，宽度会根据原视频的宽高比例作出缩放
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMediaInfoProber.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMessage.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMessage.html index ff06702..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYMessage.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMessage.html @@ -3,11 +3,11 @@ - KSYMessage Class Reference + - +
@@ -45,30 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - @@ -81,131 +59,15 @@

-

KSYMessage Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYMessage.h
- - -
- - - - - - -
-
- -

– processMessageData: -

- -
-
- -
- - -
-

处理消息数据 -@param 消息数据

-
- - - -
- (BOOL)processMessageData:(NSMutableDictionary *)messageData
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMessage.h

-
- - -
-
-
- -

  messageProcessingCallback -

- -
-
- -
- - -
-

消息处理回调接口 -@param 消息数据

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( NSDictionary *messageData ) messageProcessingCallback
- - - - - - - - - -
-

Discussion

-

请注意本函数的执行时间，如果太长可能导致不可预知的问题

-
- - - - - - - -
-

Declared In

-

KSYMessage.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMoviePlayerController.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMoviePlayerController.html index 6aceb5b..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYMoviePlayerController.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMoviePlayerController.html @@ -3,11 +3,11 @@ - KSYMoviePlayerController Class Reference + - +
@@ -43,154 +43,10 @@

@@ -203,3709 +59,16 @@

-

KSYMoviePlayerController Class Reference

+

-
- - - - - - - - - - -
Inherits fromNSObject
Conforms toKSYMediaPlayback
Declared inKSYMoviePlayerController.h
- - -
- -

Overview

-

KSYMoviePlayerController

-
- - - - - -
- - - - - - -
-
- -

– initWithContentURL: -

- -
-
- -
- - -
-

初始化播放器并设置播放地址

-
- - - -
- (instancetype)initWithContentURL:(NSURL *)url
- - - -
-

Parameters

- - - - - - - -
url

视频播放地址，该地址可以是本地地址或者服务器地址.

-
- - - -
-

Return Value

-

返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

返回KSYMoviePlayerController 实例

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

该方法初始化了播放器，并设置了播放地址。但是并没有将播放器对视频文件进行初始化，需要调用 prepareToPlay方法对视频文件进行初始化。

当前支持的协议包括：

- -
    -
  • http
    • -
  • rtmp
    • -
  • file, 本地文件
    • -
  • rtsp
    • -
-

Warning: 必须调用该方法进行初始化，不能调用init方法。

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– initWithContentURL:sharegroup: -

- -
-
- -
- - -
-

初始化播放器并设置播放地址

-
- - - -
- (instancetype)initWithContentURL:(NSURL *)url sharegroup:(EAGLSharegroup *)sharegroup
- - - -
-

Parameters

- - - - - - - - - - - - -
url

视频播放地址，该地址可以是本地地址或者服务器地址.

sharegroup

opengl的sharegroup, 用于共享视频渲染texture

-
- - - -
-

Return Value

-

返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 1.8.7 and later.

-
- - - -
-

Discussion

-

如果要获取视频渲染时的texture时(设置textureBlock属性)，需要使用此初始化函数，将EAGLSharegroup对象作为参数传入，否则texture无法在多个OpenGL的context中共享使用

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– initWithContentURL:fileList:sharegroup: -

- -
-
- -
- - -
-

初始化播放器并设置播放地址

-
- - - -
- (instancetype)initWithContentURL:(NSURL *)url fileList:(NSArray *)fileList sharegroup:(EAGLSharegroup *)sharegroup
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
url

视频播放的绝对地址，可以设置为nil;

sharegroup

opengl的sharegroup, 用于共享视频渲染texture, 可以设置为nil

list

分片列表，可以设置为nil

-
- - - -
-

Return Value

-

返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.0 and later.

-
- - - -
-

Discussion

-

该方法更适用于点播

url和list的设置逻辑:

- -
    -
  • url和fileList不能同时为空
    • -
  • url为nil，fileList不为nil时，播放器取list中的地址进行播放
    • -
  • url不nil，fileList为nil时，播放器取baseURL进行播放
    • -
  • url和fileList都不为nil，播放会认为url是绝对地址，list为相对地址，找到url中的最后一个'/‘进行url/list 拼接后播放
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  contentURL -

- -
-
-
- - -
-

正在播放的视频文件的URL地址，该地址可以是本地地址或者服务器地址。

-
- - - -
@property (nonatomic, readonly) NSURL *contentURL
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  fileList -

- -
-
- -
- - -
-

正在播放的视频文件的list列表

-
- - - -
@property (nonatomic, readonly) NSArray *fileList
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.0 and later.

-
- - - - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  view -

- -
-
- -
- - -
-

包含视频播放内容的VIEW（只读）。

-
- - - -
@property (nonatomic, readonly) UIView *view
- - - - - - - - - -
-

Discussion

-

view的使用逻辑：

- -
    -
  • 可以通过frame设置view大大小
    • -
  • 使用scalingMode 可以更改视频内容在VIEW中的显示情况
    • -
- -
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  controlStyle -

- -
-
- -
- - -
-

该属性当前不支持

-
- - - -
@property (nonatomic) MPMovieControlStyle controlStyle
- - - - - - - - -
-

Discussion

-

Warning: 该属性当前不支持

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  playbackState -

- -
-
- -
- - -
-

当前播放器的播放状态（只读）。

-
- - - -
@property (nonatomic, readonly) MPMoviePlaybackState playbackState
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

可以通过该属性获取视频播放情况：

- -

-typedef NS_ENUM(NSInteger, MPMoviePlaybackState) {
-MPMoviePlaybackStateStopped,           // 播放停止
-MPMoviePlaybackStatePlaying,           // 正在播放
-MPMoviePlaybackStatePaused,            // 播放暂停
-MPMoviePlaybackStateInterrupted,       // 播放被打断
-MPMoviePlaybackStateSeekingForward,    // 向前seeking中
-MPMoviePlaybackStateSeekingBackward    // 向后seeking中
-} NS_DEPRECATED_IOS(3_2, 9_0);
-
-

通知：

- -
    -
  • MPMoviePlayerPlaybackDidFinishNotification，当播放完成时提供通知
    • -
  • MPMoviePlayerPlaybackStateDidChangeNotification，当播放状态变化时提供通知
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  loadState -

- -
-
- -
- - -
-

当前网络加载情况

-
- - - -
@property (nonatomic, readonly) MPMovieLoadState loadState
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

可以通过该属性获取视频加载情况：

- -

-typedef NS_OPTIONS(NSUInteger, MPMovieLoadState) {
-MPMovieLoadStateUnknown        = 0,        // 加载情况未知
-MPMovieLoadStatePlayable       = 1 << 0,   // 加载完成，可以播放
-MPMovieLoadStatePlaythroughOK  = 1 << 1,   // 加载完成，如果shouldAutoplay为YES，将自动开始播放
-MPMovieLoadStateStalled        = 1 << 2,   // 如果视频正在加载中
-} NS_DEPRECATED_IOS(3_2, 9_0);
-
-

通知：

- -
    -
  • MPMoviePlayerLoadStateDidChangeNotification，当加载状态变化时提供通知
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldAutoplay -

- -
-
- -
- - -
-

播放视频时是否需要自动播放，默认值为YES。

-
- - - -
@property (nonatomic) BOOL shouldAutoplay
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  scalingMode -

- -
-
- -
- - -
-

当前缩放显示模式。

-
- - - -
@property (nonatomic) MPMovieScalingMode scalingMode
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

当前支持四种缩放模式：

- -

-typedef NS_ENUM(NSInteger, MPMovieScalingMode) {
-MPMovieScalingModeNone,       // 无缩放
-MPMovieScalingModeAspectFit,  // 同比适配，某个方向会有黑边
-MPMovieScalingModeAspectFill, // 同比填充，某个方向的显示内容可能被裁剪
-MPMovieScalingModeFill        // 满屏填充，与原始视频比例不一致
-} NS_DEPRECATED_IOS(2_0, 9_0);
-
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  duration -

- -
-
- -
- - -
-

当前视频总时长

-
- - - -
@property (nonatomic, readonly) NSTimeInterval duration
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

视频总时长，单位是秒。

- -
    -
  • 如果是直播视频源，总时长为0.
    • -
  • 如果该信息未知，总时长默认为0.
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  playableDuration -

- -
-
- -
- - -
-

当前视频可播放长度

-
- - - -
@property (nonatomic, readonly) NSTimeInterval playableDuration
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

视频可播放时长，单位是秒。

- -
    -
  • currentPlaybackTime 标记的是播放器当前已播放的时长。
    • -
  • playableDuration 标记的是播放器缓冲的时间，会稍大于currentPlaybackTime，与currentPlaybackTime的差值则是缓冲长度。
    • -
  • duration 是视频总时长。
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldEnableKSYStatModule -

- -
-
- -
- - -
-

数据统计，默认开启

-
- - - -
@property (nonatomic, assign) BOOL shouldEnableKSYStatModule
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

可开关

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  naturalSize -

- -
-
- -
- - -
-

当前视频宽高

-
- - - -
@property (nonatomic, readonly) CGSize naturalSize
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

获取信息

- -
    -
  • 监听MPMovieNaturalSizeAvailableNotification
    • -
  • 播放过程中，宽高信息可能会产生更改
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  naturalRotate -

- -
-
- -
- - -
-

当前视频自带旋转（逆时针）角度

-
- - - -
@property (nonatomic, readonly) NSInteger naturalRotate
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.2.0 and later.

-
- - - -
-

Discussion

-

rotateDegress 是人为旋转角度，naturalRotate是文件meta信息中自带的旋转角度

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  logBlock -

- -
-
- -
- - -
-

获取播放器日志

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

相关字段说明请联系金山云技术支持

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  bufferTimeMax -

- -
-
- -
- - -
-

bufferTimeMax指定播放时的缓冲时长，单位秒

-
- - - -
@property NSTimeInterval bufferTimeMax
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

对于直播流，该属性用于直播延时控制；对于点播流，该属性用于缓冲时长控制

- -
    -
  • 直播流该属性默认为2秒，设置为0或负值时为关闭直播追赶
    • -
  • 点播流该属性默认为3600秒，且与bufferSizeMax同时生效，两者取小值
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  bufferSizeMax -

- -
-
- -
- - -
-

bufferSizeMax指定点播播放时的最大缓冲，单位MB

-
- - - -
@property NSUInteger bufferSizeMax
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.0 and later.

-
- - - -
-

Discussion

-

取值大小为0-100，超过此区间时将使用默认值15。

- -
    -
  • 该属性仅对点播视频有效；
    • -
  • 默认值为15。
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  readSize -

- -
-
- -
- - -
-

已经加载的数据大小

-
- - - -
@property (nonatomic, readonly) double readSize
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

已经加载的数据大小，单位是兆。

- -
    -
  • 已经加载的全部数据大小，包括音频和视频。
    • -
  • 数据包括已经播放的，和当前的cache数据。
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  bufferEmptyDuration -

- -
-
- -
- - -
-

buffer为空时，拉取数据所耗的时长

-
- - - -
@property (nonatomic, readonly) NSTimeInterval bufferEmptyDuration
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

当buffer为空时，开始统计。单位为秒。

- -
    -
  • 当MPMoviePlayerLoadStateDidChangeNotification 通知发起；
    • -
  • MPMovieLoadState状态为MPMovieLoadStateStalled 开始计时；
    • -
  • MPMovieLoadState状态为MPMovieLoadStatePlayable 或者 MPMovieLoadStatePlaythroughOK时，结束计时；
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  bufferEmptyCount -

- -
-
- -
- - -
-

发起cache的次数

-
- - - -
@property (nonatomic, readonly) NSInteger bufferEmptyCount
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

当buffer为空时，统计一次，统计的条件为

- -
    -
  • 当MPMoviePlayerLoadStateDidChangeNotification 通知发起
    • -
  • MPMovieLoadState 状态为MPMovieLoadStateStalled
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  serverAddress -

- -
-
- -
- - -
-

视频流server ip

-
- - - -
@property (nonatomic, readonly) NSString *serverAddress
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

当收到prepared后，即可以查询当前连接的视频流server ip

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  clientIP -

- -
-
- -
- - -
-

客户端出口IP

-
- - - -
@property (nonatomic, readonly) NSString *clientIP
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.0.1 and later.

-
- - - -
-

Discussion

-

当收到prepared后，即可以查询客户端的出口IP

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  localDNSIP -

- -
-
- -
- - -
-

客户端LocalDNSIP

-
- - - -
@property (nonatomic, readonly) NSString *localDNSIP
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.0.1 and later.

-
- - - -
-

Discussion

-

当收到prepared后，即可以查询客户端的LocalDNSIP

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  qosInfo -

- -
-
- -
- - -
-

视频流qos信息

-
- - - -
@property (nonatomic, strong) KSYQosInfo *qosInfo
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

在播放过程中，即可以查询当前连接的视频流qos信息

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– thumbnailImageAtCurrentTime -

- -
-
- -
- - -
-

截图

-
- - - -
- (UIImage *)thumbnailImageAtCurrentTime
- - - - - -
-

Return Value

-

当前时刻的视频UIImage 图像

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldEnableVideoPostProcessing -

- -
-
- -
- - -
-

是否开启视频后处理

-
- - - -
@property (nonatomic) BOOL shouldEnableVideoPostProcessing
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

默认是关闭

- - -

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  videoDecoderMode -

- -
-
- -
- - -
-

是否开启硬件解码

-
- - - -
@property (nonatomic, assign) MPMovieVideoDecoderMode videoDecoderMode
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

如果系统版本高于8.0，默认开启硬件解码；否则，默认使用软件解码

- - -

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldMute -

- -
-
- -
- - -
-

是否静音

-
- - - -
@property (nonatomic) BOOL shouldMute
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldHideVideo -

- -
-
- -
- - -
-

是否隐藏视频

-
- - - -
@property (nonatomic) BOOL shouldHideVideo
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.6.1 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  shouldLoop -

- -
-
- -
- - -
-

是否循环播放

-
- - - -
@property (nonatomic) BOOL shouldLoop
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

默认不循环

- -
    -
  • 只在prepareToPlay 调用前设置生效；
    • -
  • 只有点播生效,直播场景请勿设置
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  videoDataBlock -

- -
-
- -
- - -
-

视频数据回调

-
- - - -
@property (nonatomic, copy) KSYPlyVideoDataBlock videoDataBlock
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.3 and later.

-
- - - -
-

Discussion

-

调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  audioDataBlock -

- -
-
- -
- - -
-

音频数据回调

-
- - - -
@property (nonatomic, copy) KSYPlyAudioDataBlock audioDataBlock
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.3 and later.

-
- - - -
-

Discussion

-

调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  messageDataBlock -

- -
-
- -
- - -
-

消息数据回调

-
- - - -
@property (nonatomic, copy) KSYPlyMessageDataBlock messageDataBlock
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.3 and later.

-
- - - -
-

Discussion

-

调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  textureBlock -

- -
-
- -
- - -
-

视频图像texture回调

-
- - - -
@property (nonatomic, copy) KSYPlyTextureBlock textureBlock
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.8.7 and later.

-
- - - -
-

Discussion

-

调用prepareToPlay方法之前设置生效

Warning: 该方法由金山云引入，不是原生系统接口。使用该属性时需要在初始化时使用initWithContentURL:sharegroup:函数初始化播放器，否则该属性无效

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  rotateDegress -

- -
-
- -
- - -
-

指定逆时针旋转角度，只能是0/90/180/270, 不符合上述值不进行旋转

-
- - - -
@property (nonatomic) int rotateDegress
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.4.1 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  mirror -

- -
-
- -
- - -
-

指定视频是否镜像显示

-
- - - -
@property (nonatomic) BOOL mirror
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.8.4 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  superFastPlay -

- -
-
- -
- - -
-

快速播放

-
- - - -
@property (nonatomic) BOOL superFastPlay
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.2 and later.

-
- - - -
-

Discussion

-

默认不快速播放

- -
    -
  • 非固定倍速下的快速播放，而是全速将解码器中的数据显示出来
    • -
  • 当播放文件存在音频时该功能生效；
    • -
  • 播放前或者播放过程中均可配置；
    • -
  • 开启快速播放后，不在输出声音，但是audioDataBlock中依然会上抛pcm数据
    • -
  • 开启快速播放后，可能会导致播放器不停的进入/结束缓冲状态；
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  deinterlaceMode -

- -
-
- -
- - -
-

是否进行视频反交错处理

-
- - - -
@property (nonatomic) MPMovieVideoDeinterlaceMode deinterlaceMode
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.7.2 and later.

-
- - - -
-

Discussion

-

默认不进行反交错处理

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  bInterruptOtherAudio -

- -
-
- -
- - -
-

是否打断其他后台的音乐播放

-
- - - -
@property (nonatomic) BOOL bInterruptOtherAudio
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.3 and later.

-
- - - -
-

Discussion

-

也可以理解为是否允许和其他音频同时播放

YES:开始播放时，会打断其他的后台播放音频，也会被其他音频播放打断

NO: 可以与其他后台播放共存，相互之间不会被打断

默认为YES

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  audioPan -

- -
-
- -
- - -
-

立体声平衡模式，默认立体声输出

-
- - - -
@property (nonatomic) MPMovieAudioPan audioPan
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.0.3 and later

-
- - - -
-

Discussion

-

针对单声道或双声道音频播放配置时有效，多声道音频播放配置无效

需要佩戴耳机以区分左右声道，手机外放无效果

prepareToPlay前配置无效，应在播放过程中动态配置

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  networkDetectURL -

- -
-
- -
- - -
-

用于检测网络连通性的地址，默认使用地址为“www.baidu.com”

-
- - - -
@property (nonatomic, readwrite) NSString *networkDetectURL
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.1 and later

-
- - - -
-

Discussion

-

用户可自定义地址，但不可设置无效地址，如果不清楚规则，建议使用默认值

设置为nil时，则关闭网络连通性的检测, networkStatus属性值为-1

建议在创建对象后设置一次或不设置，不推荐在播放过程中动态配置

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  networkStatus -

- -
-
- -
- - -
-

网络连通状态

-
- - - -
@property (nonatomic, readonly) KSYNetworkStatus networkStatus
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.1 and later

-
- - - -
-

Discussion

-

使用 www.kingsoft.com 作为检测目标

如果networkStatus不等于KSYNetworkStatus枚举中的任意值，则表明当前尚未监测到网络状态

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

  playbackSpeed -

- -
-
- -
- - -
-

设置播放速度，取值范围(0.5~2.0)，默认1.0

-
- - - -
@property (nonatomic) float playbackSpeed
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.4.1 and later.

-
- - - -
-

Discussion

-

Warning: 该属性由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setTimeout:readTimeout: -

- -
-
- -
- - -
-

timeout指定拉流超时时间,单位是秒

-
- - - -
- (void)setTimeout:(int)prepareTimeout readTimeout:(int)readTimeout
- - - -
-

Parameters

- - - - - - - - - - - - -
prepareTimeout

建立链接超时时间，默认值是10秒

readTimeout

拉流超时时间，默认值是30秒

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setVolume:rigthVolume: -

- -
-
- -
- - -
-

setVolume指定播放器输出音量

-
- - - -
- (void)setVolume:(float)leftVolume rigthVolume:(float)rightVolume
- - - -
-

Parameters

- - - - - - - - - - - - -
leftVolume

left volume scalar [0~2.0f]

rightVolume

right volume scalar [0~2.0f]

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.3 and later.

-
- - - -
-

Discussion

-

使用说明

- -
    -
  • 输入参数超出范围将失效
    • -
  • 输出到speaker时需同时设置左右音量为有效值 - 如：leftVolume ＝ rightVolume ＝ 0.5f
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– getVersion -

- -
-
- -
- - -
-

获取sdk版本

-
- - - -
- (NSString *)getVersion
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– getMetadata -

- -
-
- -
- - -
-

获取播放Meta信息

-
- - - -
- (NSDictionary *)getMetadata
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.3.1 and later.

-
- - - -
-

Discussion

-

收到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知后才能获取到数据

暂时支持的查询包括

- -
    -
  • kKSYPLYHttpFirstDataTime 建链成功后到收到第一个包所消耗的时间
    • -
  • kKSYPLYHttpConnectTime 链接服务器所消耗的时间
    • -
  • kKSYPLYHttpAnalyzeDns 解析DNS所消耗的时间
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– getMetadata: -

- -
-
- -
- - -
-

获取播放Meta

-
- - - -
- (NSDictionary *)getMetadata:(MPMovieMetaType)metaType
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.5.2 and later.

-
- - - -
-

Discussion

-

收到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知后才能获取到数据

暂时支持的查询包括

- -
    -
  • 当metaType为MPMovieMetaType_Media时，所得到的结果与getMetadata方法相同
    • -
  • 当metaType为其他类型时，得到的当前播放的视频/音频/字幕流的meta信息
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– isPlaying -

- -
-
- -
- - -
-

当前播放器是否在播放

-
- - - -
- (BOOL)isPlaying
- - - - - -
-

Return Value

-

获取playbackState信息，如果当前状态为MPMoviePlaybackStatePlaying，则返回TRUE。其他情况返回FASLE。

-
- - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– reload: -

- -
-
- -
- - -
-

重新启动拉流

-
- - - -
- (void)reload:(NSURL *)aUrl
- - - -
-

Parameters

- - - - - - - -
aUrl

视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

调用场景如下：

- -
    -
  • 当播放器调用方发现卡顿时，可以主动调用
    • -
  • 当估计出更优质的拉流ip时，可以主动调用
    • -
  • 当发生WiFi/3G网络切换时，可以主动调用
    • -
  • 当播放器回调体现播放完成时，可以主动调用
    • -
  • 播放器SDK不会自动调用reload功能
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– reload:flush: -

- -
-
- -
- - -
-

重新启动拉流

-
- - - -
- (void)reload:(NSURL *)aUrl flush:(BOOL)flush
- - - -
-

Parameters

- - - - - - - - - - - - -
aUrl

视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

flush

是否清除上一个url的缓冲区内容，该值为NO不清除，为YES则清除

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.0 and later.

-
- - - -
-

Discussion

-

说明：

- -
    -
  • 如果在直播过程中使用reload，希望达到续播的效果，建议flush值设为NO
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– reload:flush:mode: -

- -
-
- -
- - -
-

重新启动拉流

-
- - - -
- (void)reload:(NSURL *)aUrl flush:(bool)flush mode:(MPMovieReloadMode)mode
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
aUrl

视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

flush

是否清除上一个url的缓冲区内容，该值为NO不清除，为YES则清除

mode

配置reload后的加载模式，该值为MPMovieReloadModeFast则启用加速播放；若为MPMovieReloadModeAccurate则启用精准查找模式播放

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.6.3 and later.

-
- - - -
-

Discussion

-

说明：

- -
    -
  • 如果在直播过程中使用reload，希望达到续播的效果，建议flush值设为NO
    • -
  • 设置为MPMovieReloadMode_Fast模式可以加快起播速度，但在码流音视频交织较差的情况下，可能无法检测到所有音视频流
    • -
  • 设置为MPMovieReloadMode_Accurate模式起播速度会有所下降，但可以保证检测到所有音视频流
    • -
  • 如果是监听到MPMoviePlayerSuggestReloadNotification消息后调用reload接口，则mode模式一定要设置为MPMovieReloadMode_Accurate，其它情况可根据实际使用场景自行配置
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– getCurrentPts -

- -
-
- -
- - -
-

获取当前播放的pts

-
- - - -
- (NSTimeInterval)getCurrentPts
- - - - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.5.0.0 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setUrl: -

- -
-
- -
- - -
-

设置播放url

-
- - - -
- (void)setUrl:(NSURL *)url
- - - -
-

Parameters

- - - - - - - -
url

视频播放地址，该地址可以是本地地址或者服务器地址.

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.6.2 and later.

-
- - - -
-

Discussion

-

使用说明

- -
    -
  • 通常用于使用一个对象进行多次播放的场景
    • -
  • 调用reset接口停止播放后使用该接口来设置下一次播放地址
    • -
  • 需要在prepareToPlay方法之前设置
    • -
  • v2.1.0及之后的版本，该url不可设置为nil；之前的版本设置为nil，会播放上一次的播放地址
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setUrl:fileList: -

- -
-
- -
- - -
-

设置播放url

-
- - - -
- (void)setUrl:(NSURL *)url fileList:(NSArray *)fileList
- - - -
-

Parameters

- - - - - - - - - - - - -
fileList

分片列表

baseURL

视频播放的绝对地址，该地址可以是本地地址或者服务器地址

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.1.0 and later.

-
- - - -
-

Discussion

-

url和fileList不可同时为nil

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– reset: -

- -
-
- -
- - -
-

重置播放器

-
- - - -
- (void)reset:(BOOL)holdLastPic
- - - -
-

Parameters

- - - - - - - -
holdLastPic

是否保留最后一帧

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.6.2 and later.

-
- - - -
-

Discussion

-

使用说明

- -
    -
  • 通常用于使用一个对象进行多次播放的场景
    • -
  • 该方法可以停止播放，但是不会销毁播放器
    • -
  • 调用该方法后可以通过调用stop方法来销毁播放器
    • -
  • 如果使用一个对象进行多次播放，需要在reset后使用setUrl方法设置下次播放地址
    • -
-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– seekTo:accurate: -

- -
-
- -
- - -
-

跳转到指定位置播放

-
- - - -
- (void)seekTo:(double)pos accurate:(BOOL)isAccurate
- - - -
-

Parameters

- - - - - - - - - - - - -
pos

跳转到的位置，单位秒

isAccurate

是否精确跳转，NO时等同于currentPlaybackTime, YES时为精确跳转

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 1.9.1 and later.

-
- - - -
-

Discussion

-

媒体文件总时长较小且关键帧间隔较大时，需要使用精确跳转， 总时长较大或者不需要精确定位时可以使用currentPlaybackTime或者将isAccurate设置为NO进行跳转

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setHttpHeaders: -

- -
-
- -
- - -
-

发送http请求时需要header带上的字段

-
- - - -
- (void)setHttpHeaders:(NSDictionary *)headers
- - - -
-

Parameters

- - - - - - - -
header

自定义http header字段

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.0.3 and later.

-
- - - -
-

Discussion

-

在调用prepareToPlay方法前调用生效

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setTrackSelected:selected: -

- -
-
- -
- - -
-

设置开启/关闭指定的媒体轨道

-
- - - -
- (void)setTrackSelected:(NSInteger)trackIndex selected:(BOOL)selected
- - - -
-

Parameters

- - - - - - - - - - - - -
trackIndex
    -
  • 轨道的stream index
    • -
-
selected
    -
  • 开启/关闭指定媒体轨道
    • -
-
-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.5.2 and later.

-
- - - -
-

Discussion

-

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
- -

– setExtSubtitleFilePath: -

- -
-
- -
- - -
-

设置本地字幕文件的地址

-
- - - -
- (void)setExtSubtitleFilePath:(NSString *)subtitleFilePath
- - - -
-

Parameters

- - - - - - - -
subtitleFilePath

本地字幕文件地址

-
- - - - - -
-

Availability

-

Available in KSYMoviePlayerController 2.5.2 and later.

-
- - - -
-

Discussion

-

在播放过程中调用

Warning: 该方法由金山云引入，不是原生系统接口

-
- - - - - - - -
-

Declared In

-

KSYMoviePlayerController.h

-
- - -
-
-
-
- -
- - - - - - -
+ +
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMovieWriter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMovieWriter.html index 6f832f4..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYMovieWriter.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMovieWriter.html @@ -3,11 +3,11 @@ - KSYMovieWriter Class Reference + - +
@@ -43,30 +43,10 @@

@@ -79,149 +59,15 @@

-

KSYMovieWriter Class Reference

+

-
- - - - - - - -
Inherits fromKSYStreamerBase : NSObject
Declared inKSYMovieWriter.h
- - -
- -

Overview

-

视频文件录制类

-
- - - -
- - - - - - -
-
- -

– startWrite: -

- -
-
- -
- - -
-

write video stream to local files

-
- - - -
- (void)startWrite:(NSURL *)filePath
- - - -
-

Parameters

- - - - - - - -
filePath

is local file path

-
- - - - - - - -
-

Discussion

-

开始写文件前需要设定好编码参数

编码参数主要是视频编码器，音视频码率的设置

-
- - - - - - - -
-

Declared In

-

KSYMovieWriter.h

-
- - -
-
-
- -

– stopWrite -

- -
-
- -
- - -
-

stop wirte file

-
- - - -
- (void)stopWrite
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMovieWriter.h

-
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMvEffect.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMvEffect.html new file mode 100644 index 0000000..4e8eace --- /dev/null +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMvEffect.html @@ -0,0 +1,87 @@ + + + + + + + + + + + + +
+
+ +

+ KSYLive_iOS +

+ +

+ Kingsoft +

+ +
+
+ + + +
+
+
+
+

+ + + + + + + + +
+ +
+
+ +

Copyright © 2017 Kingsoft. All rights reserved.

+ + +
+
+
+
+
+ + + + diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYMvFilter.html b/doc/docset/Contents/Resources/Documents/Classes/KSYMvFilter.html new file mode 100644 index 0000000..4e8eace --- /dev/null +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYMvFilter.html @@ -0,0 +1,87 @@ + + + + + + + + + + + + +
+
+ +

+ KSYLive_iOS +

+ +

+ Kingsoft +

+ +
+
+ + + +
+
+
+
+

+ + + + + + + + +
+ +
+
+ +

Copyright © 2017 Kingsoft. All rights reserved.

+ + +
+
+
+
+
+ + + + diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYNetRouterInfo.html b/doc/docset/Contents/Resources/Documents/Classes/KSYNetRouterInfo.html index a2f30f3..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYNetRouterInfo.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYNetRouterInfo.html @@ -3,11 +3,11 @@ - KSYNetRouterInfo Class Reference + - +
@@ -43,40 +43,10 @@

@@ -89,342 +59,15 @@

-

KSYNetRouterInfo Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYNetTracker.h
- - -
- -

Overview

-

网络链路上的路由节点信息类

-
- - - - - -
- - - - - - -
-
- -

  ips -

- -
-
- -
- - -
-

链路上每个节点的ip地址

-
- - - -
@property (nonatomic, readonly) NSMutableArray *ips
- - - - - - - - - -
-

Discussion

-

如果每个探测报文对应的路径不同，则每一跳上会存在多个不同ip

-
- - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  tmax -

- -
-
- -
- - -
-

所有探测报文的rtt最大值

-
- - - -
@property (nonatomic, readonly) float tmax
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  tmin -

- -
-
- -
- - -
-

所有探测报文的rtt最小值

-
- - - -
@property (nonatomic, readonly) float tmin
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  tavg -

- -
-
-
- - -
-

所有探测报文的rtt平均值

-
- - - -
@property (nonatomic, readonly) float tavg
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  tdev -

- -
-
- -
- - -
-

所有探测报文的rtt均方差

-
- - - -
@property (nonatomic, readonly) float tdev
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  loss -

- -
-
- -
- - -
-

所有探测报文的丢包率

-
- - - -
@property (nonatomic, readonly) float loss
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  number -

- -
-
- -
- - -
-

统计所使用的探测报文个数

-
- - - -
@property (nonatomic, readonly) int number
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYNetTracker.html b/doc/docset/Contents/Resources/Documents/Classes/KSYNetTracker.html index eb8ea85..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYNetTracker.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYNetTracker.html @@ -3,11 +3,11 @@ - KSYNetTracker Class Reference + - +
@@ -43,44 +43,10 @@

@@ -93,397 +59,15 @@

-

KSYNetTracker Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYNetTracker.h
- - -
- -

Overview

-

网络链路探测器类

-
- - - -
- - - - - - -
-
- -

– start: -

- -
-
- -
- - -
-

开始探测

-
- - - -
- (int)start:(NSString *__nonnull)domain
- - - -
-

Parameters

- - - - - - - -
domain

探测地址

-
- - - -
-

Return Value

-

成功开始返回0, 否则返回非0

-
- - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

– stop -

- -
-
- -
- - -
-

停止探测

-
- - - -
- (void)stop
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  action -

- -
-
- -
- - -
-

探测方式

-
- - - -
@property (nonatomic, assign) KSY_NETTRACKER_ACTION action
- - - - - - - - - -
-

Discussion

-

说明：

- -
    -
  • start开始前配置有效，探测过程中配置下一次探测生效
    • -
- -
- - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  timeout -

- -
-
- -
- - -
-

探测超时时间，单位是ms，默认值是1000ms

-
- - -
@property (nonatomic, assign) int timeout
- - - - - - - - - -
-

Discussion

-

说明：

- -
    -
  • start开始前配置有效，探测过程中配置下一次探测生效
    • -
  • 有效范围是100-2000ms，不在有效范围内的配置不生效
    • -
- -
- - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  maxttl -

- -
-
- -
- - -
-

探测使用的最大ttl值，默认值是64

-
- - - -
@property (nonatomic, assign) int maxttl
- - - - - - - - - -
-

Discussion

-

说明：

- -
    -
  • start开始前配置有效，探测过程中配置下一次探测生效
    • -
  • 有效范围是1-int最大值，不在有效范围内的配置不生效
    • -
- -
- - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  number -

- -
-
- -
- - -
-

探测次数，默认值是10

-
- - - -
@property (nonatomic, assign) int number
- - - - - - - - - -
-

Discussion

-

说明：

- -
    -
  • start开始前配置有效，探测过程中配置下一次探测生效
    • -
  • 有效范围是1-20，不在有效范围内的配置不生效
    • -
- -
- - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
- -

  routerInfo -

- -
-
- -
- - -
-

链路状况

-
- - - -
@property (nonatomic, readonly) NSMutableArray *routerInfo
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYNetTracker.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYQosInfo.html b/doc/docset/Contents/Resources/Documents/Classes/KSYQosInfo.html index 4bb1eb0..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYQosInfo.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYQosInfo.html @@ -3,11 +3,11 @@ - KSYQosInfo Class Reference + - +
@@ -43,44 +43,10 @@

@@ -93,428 +59,15 @@

-

KSYQosInfo Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYQosInfo.h
- - -
- -

Overview

-

Qos信息

-
- - - - - -
- - - - - - -
-
- -

  audioBufferByteLength -

- -
-
- -
- - -
- 
audio queue size in bytes
-
-
- - - -
@property (nonatomic, assign) int audioBufferByteLength
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  audioBufferTimeLength -

- -
-
- -
- - -
- 
audio queue time length in ms
-
-
- - - -
@property (nonatomic, assign) int audioBufferTimeLength
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  audioTotalDataSize -

- -
-
- -
- - -
- 
size of data have arrived at audio queue since playing. unit:byte
-
-
- - - -
@property (nonatomic, assign) int64_t audioTotalDataSize
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  videoBufferByteLength -

- -
-
- -
- - -
- 
video queue size in bytes
-
-
- - - -
@property (nonatomic, assign) int videoBufferByteLength
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  videoBufferTimeLength -

- -
-
- -
- - -
- 
video queue time length in ms
-
-
- - - -
@property (nonatomic, assign) int videoBufferTimeLength
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  videoTotalDataSize -

- -
-
- -
- - -
- 
size of data have arrived at video queue since playing. unit:byte
-
-
- - - -
@property (nonatomic, assign) int64_t videoTotalDataSize
- - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  totalDataSize -

- -
-
- -
- - -
- 
size of total audio and video data since playing. unit: byte
-
-
- - - -
@property (nonatomic, assign) int64_t totalDataSize
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  videoDecodeFPS -

- -
-
- -
- - -
- 
video decode frame count per second
-
-
- - - -
@property (nonatomic, assign) float videoDecodeFPS
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
- -

  videoRefreshFPS -

- -
-
- -
- - -
- 
video refresh frame count per second
-
-
- - - -
@property (nonatomic, assign) float videoRefreshFPS
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYQosInfo.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYReachability.html b/doc/docset/Contents/Resources/Documents/Classes/KSYReachability.html index 4e9bde0..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYReachability.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYReachability.html @@ -3,11 +3,11 @@ - KSYReachability Class Reference + - +
@@ -45,76 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -127,410 +59,15 @@

-

KSYReachability Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYReachability.h
- - -
- - - - - - -
-
- -

  reachableBlock -

- -
-
- -
- - -
@property (nonatomic, copy) KSYNetworkReachable reachableBlock
- - -
-
-
- -

  unreachableBlock -

- -
-
- -
- - -
@property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock
- - -
-
-
- -

  reachabilityBlock -

- -
-
- -
- - -
@property (nonatomic, copy) KSYNetworkReachability reachabilityBlock
- - -
-
-
- -

  reachableOnWWAN -

- -
-
- -
- - -
@property (nonatomic, assign) BOOL reachableOnWWAN
- - -
-
-
- -

+ reachabilityWithHostname: -

- -
-
- -
- - -
+ (instancetype)reachabilityWithHostname:(NSString *)hostname
- - -
-
-
- -

+ reachabilityWithHostName: -

- -
-
- -
- - -
+ (instancetype)reachabilityWithHostName:(NSString *)hostname
- - -
-
-
- -

+ reachabilityForInternetConnection -

- -
-
- -
- - -
+ (instancetype)reachabilityForInternetConnection
- - -
-
-
- -

+ reachabilityWithAddress: -

- -
-
- -
- - -
+ (instancetype)reachabilityWithAddress:(void *)hostAddress
- - -
-
-
- -

+ reachabilityForLocalWiFi -

- -
-
- -
- - -
+ (instancetype)reachabilityForLocalWiFi
- - -
-
-
- -

– initWithReachabilityRef: -

- -
-
- -
- - -
- (instancetype)initWithReachabilityRef:(SCNetworkReachabilityRef)ref
- - -
-
-
- -

– startNotifier -

- -
-
- -
- - -
- (BOOL)startNotifier
- - -
-
-
- -

– stopNotifier -

- -
-
- -
- - -
- (void)stopNotifier
- - -
-
-
- -

– isReachable -

- -
-
- -
- - -
- (BOOL)isReachable
- - -
-
-
- -

– isReachableViaWWAN -

- -
-
- -
- - -
- (BOOL)isReachableViaWWAN
- - -
-
-
- -

– isReachableViaWiFi -

- -
-
- -
- - -
- (BOOL)isReachableViaWiFi
- - -
-
-
- -

– isConnectionRequired -

- -
-
- -
- - -
- (BOOL)isConnectionRequired
- - -
-
-
- -

– connectionRequired -

- -
-
- -
- - -
- (BOOL)connectionRequired
- - -
-
-
- -

– isConnectionOnDemand -

- -
-
- -
- - -
- (BOOL)isConnectionOnDemand
- - -
-
-
- -

– isInterventionRequired -

- -
-
- -
- - -
- (BOOL)isInterventionRequired
- - -
-
-
- -

– currentReachabilityStatus -

- -
-
- -
- - -
- (KSYNetworkStatus)currentReachabilityStatus
- - -
-
-
- -

– reachabilityFlags -

- -
-
- -
- - -
- (SCNetworkReachabilityFlags)reachabilityFlags
- - -
-
-
- -

– currentReachabilityString -

- -
-
- -
- - -
- (NSString *)currentReachabilityString
- - -
-
-
- -

– currentReachabilityFlags -

- -
-
- -
- - -
- (NSString *)currentReachabilityFlags
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYSpecialEffects.html b/doc/docset/Contents/Resources/Documents/Classes/KSYSpecialEffects.html index 5b4618b..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYSpecialEffects.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYSpecialEffects.html @@ -3,11 +3,11 @@ - KSYSpecialEffects Class Reference + - +
@@ -43,42 +43,10 @@

@@ -91,245 +59,15 @@

-

KSYSpecialEffects Class Reference

+

-
- - - - - - - -
Inherits fromGPUImageFilterGroup
Declared inKSYSpecialEffects.h
- - -
- -

Overview

-

金山云特效滤镜

- -

通过导入查找表资源实现的特效滤镜

-
- - - - - -
- - - - - - -
-
- -

+ showVersion -

- -
-
- -
- - -
-

show version of this filter

-
- - - -
+ (void)showVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYSpecialEffects.h

-
- - -
-
-
- -

– initWithUIImage: -

- -
-
- -
- - -
-

初始化并指定特效素材

-
- - - -
- (id)initWithUIImage:(UIImage *)image
- - - -
-

Parameters

- - - - - - - -
image

特效素材

-
- - - -
-

Return Value

-

构造的滤镜

-
- - - - - - - - - - - -
-

Declared In

-

KSYSpecialEffects.h

-
- - -
-
-
- -

– setSpecialEffectsUIImage: -

- -
-
-
- - -
-

指定特效素材

-
- - - -
- (void)setSpecialEffectsUIImage:(UIImage *)image
- - - -
-

Parameters

- - - - - - - -
image

特效素材

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYSpecialEffects.h

-
- - -
-
-
- -

  intensity -

- -
-
- -
- - -
-

特效参数

-
- - - -
@property (readwrite, nonatomic) CGFloat intensity
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYSpecialEffects.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYStreamerBase.html b/doc/docset/Contents/Resources/Documents/Classes/KSYStreamerBase.html index 43f6ea1..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYStreamerBase.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYStreamerBase.html @@ -3,11 +3,11 @@ - KSYStreamerBase Class Reference + - +
@@ -43,174 +43,10 @@

@@ -223,3641 +59,23 @@

-

KSYStreamerBase Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYStreamerBase.h
- - -
- -

Overview

-

金山云直播推流SDK iOS版提供了iOS移动设备上的推流功能

- -
    -
  • 音频编码采用AAC编码，码率可配置;
    • -
  • 视频频编码采用H.264编码，码率可配置;
    • -
  • 支持 RTMP 协议直播推流;
    • -
  • 支持写入本地flv和mp4文件;
    • -
  • 支持推流同时旁路录像功能;
    • -
- -

Found: 2015-10-15

-
- - - -
- - + +
- - - -
-
- -

– getKSYVersion -

- -
-
- -
- - -
-

获取SDK版本号

-
- - - -
- (NSString *)getKSYVersion
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  hostURL -

- -
-
- -
- - -
-

直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径

-
- - - -
@property (nonatomic, readonly) NSURL *hostURL
- - - - - - - - - -
-

Discussion

-

直播时将音视频流推向该主机或写入本地文件

- -
eg: rtmp://xxx.xxx.xxx.xxx/appname/streamKey
-eg: /var/xxxxx/xxx.mp4  /var/xxxxx/xxx.flv
-
-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoFPS -

- -
-
- -
- - -
-

视频帧率 默认:15

-
- - - -
@property (nonatomic, assign) int videoFPS
- - - - - - - - - -
-

Discussion

-

请保持调用 processVideoSampleBuffer 或 processVideoPixelBuffer 的频率与此设置的帧率一致

当实际送入的视频帧率过高时会主动丢帧

video frame per seconds 有效范围[1~30], 超出会提示参数错误

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoMinFPS -

- -
-
- -
- - -
-

视频帧率最小值，默认与videoFPS相同

-
- - - -
@property (nonatomic, assign) int videoMinFPS
- - - - - - - - - -
-

Discussion

-

video frame per seconds 有效范围[1~30], 超出会提示参数错误

不设置该值时表示网络自适应不使用动态帧率

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoMaxFPS -

- -
-
- -
- - -
-

视频帧率最大值，默认与videoFPS相同

-
- - - -
@property (nonatomic, assign) int videoMaxFPS
- - - - - - - - - -
-

Discussion

-

video frame per seconds 有效范围[1~30], 超出会提示参数错误

不设置该值时表示网络自适应不使用动态帧率

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoCodec -

- -
-
- -
- - -
-

视频编码器 默认为 自动选择

-
- - - -
@property (nonatomic, assign) KSYVideoCodec videoCodec
- - - - - - - - - -
-

Discussion

-

video codec used for encode

修改此选项会导致videoEncodePerf值变化

如果需要定制编码档次, 请在修改videoCodec之后再测设置

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  audioCodec -

- -
-
- -
- - -
-

音频编码器 (默认为AAC-HE)

-
- - - -
@property (nonatomic, assign) KSYAudioCodec audioCodec
- - - - - - - - - -
-

Discussion

-

audio codec used for encode

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoInitBitrate -

- -
-
- -
- - -
-

视频编码起始码率（单位:kbps, 默认:500）

-
- - - -
@property (nonatomic, assign) int videoInitBitrate
- - - - - - - - - -
-

Discussion

-

开始推流时的视频码率，开始推流后，根据网络情况在Min~Max范围内调节

视频码率上调则画面更清晰，下调则画面更模糊

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoMaxBitrate -

- -
-
- -
- - -
-

视频编码最高码率（单位:kbps, 默认:800）

-
- - - -
@property (nonatomic, assign) int videoMaxBitrate
- - - - - - - - - -
-

Discussion

-

视频码率自适应调整的上限, 为目标码率

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoMinBitrate -

- -
-
- -
- - -
-

视频编码最低码率（单位:kbps, 默认:200）

-
- - - -
@property (nonatomic, assign) int videoMinBitrate
- - - - - - - - - -
-

Discussion

-

视频码率自适应调整的下限

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  streamMetaData -

- -
-
- -
- - -
-

推流全局附带的metadata (默认为nil)

-
- - - -
@property (atomic, copy) NSDictionary *streamMetaData
- - - - - - - - - -
-

Discussion

-

key 一定要是 NSString* 类型的

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoMetaData -

- -
-
- -
- - -
-

视频流附带的metadata (默认为nil)

-
- - - -
@property (atomic, copy) NSDictionary *videoMetaData
- - - - - - - - - -
-

Discussion

-

key 一定要是 NSString* 类型的; 目前有效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoCrf -

- -
-
- -
- - -
-

质量等级（默认:20）

-
- - - -
@property (nonatomic, assign) int videoCrf
- - - - - - - - - -
-

Discussion

-

视频恒定质量等级，范围0～51，值越小，质量越好

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  maxKeyInterval -

- -
-
- -
- - -
-

最大关键帧间隔（单位:秒, 默认:3）

-
- - - -
@property (nonatomic, assign) float maxKeyInterval
- - - - - - - - - -
-

Discussion

-

即GOP长度 画面静止时,隔n秒插入一个关键帧

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  audiokBPS -

- -
-
- -
- - -
-

音频编码码率（单位:kbps）

-
- - - -
@property (nonatomic, assign) int audiokBPS
- - - - - - - - - -
-

Discussion

-

音频目标编码码率 (比如48,96,128等)

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bwEstimateMode -

- -
-
- -
- - -
-

带宽估计模式

-
- - - -
@property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode
- - - - - - - - - -
-

Discussion

-

带宽估计的策略选择 (开始推流前设置有效)

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  liveScene -

- -
-
- -
- - -
-

本次直播的目标场景 (默认为KSYLiveScene_Default)

-
- - - -
@property (nonatomic, assign) KSYLiveScene liveScene
- - - - - - - - - -
-

Discussion

-

KSY内部会根据场景的特征进行参数调优,开始推流前设置有效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  recScene -

- -
-
- -
- - -
-

本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate)

-
- - - -
@property (nonatomic, assign) KSYRecScene recScene
- - - - - - - - - -
-

Discussion

-

开始录制前设置有效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoEncodePerf -

- -
-
- -
- - -
-

视频编码性能档次

-
- - - -
@property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf
- - - - - - - - - -
-

Discussion

-

视频质量和设备资源之间的权衡,开始推流前, videoCodec设置之后,修改有效

选择软编码的默认为KSYVideoEncodePer_LowPower

选择Auto或硬编码的默认为KSYVideoEncodePer_HighPerformance

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bWithVideo -

- -
-
- -
- - -
-

是否处理视频的图像数据 (默认YES)

-
- - - -
@property (nonatomic, assign) BOOL bWithVideo
- - - - - - - - - -
-

Discussion

-

Warning: 如果在推流前设置为NO, 则在推流过程中无法再开启图像

启动推流前设置为NO, 推流过程中修改本属性无效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bWithAudio -

- -
-
- -
- - -
-

是否处理音频数据 (默认YES)

-
- - - -
@property (nonatomic, assign) BOOL bWithAudio
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bWithMessage -

- -
-
- -
- - -
-

是否处理Message (默认YES)

-
- - - -
@property (nonatomic, assign) BOOL bWithMessage
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  scaleRatio -

- -
-
- -
- - -
-

cpu缩放比率,设置>0为按比例缩放，默认为0

-
- - - -
@property (nonatomic, assign) float scaleRatio
- - - - - - - - - -
-

Discussion

-

Warning: 请在推流之前进行设置

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  streamState -

- -
-
- -
- - -
-

当前推流状况

-
- - - -
@property (nonatomic, readonly) KSYStreamState streamState
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取推流会话的工作状况

通知： -* KSYStreamStateDidChangeNotification 当推流工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– getStreamStateName: -

- -
-
- -
- - -
-

获取推流状态对应的字符串

-
- - - -
- (NSString *)getStreamStateName:(KSYStreamState)stat
- - - -
-

Parameters

- - - - - - - -
stat

状态码

-
- - - -
-

Return Value

-

状态名称

-
- - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– getCurStreamStateName -

- -
-
- -
- - -
-

获取当前推流状态对应的字符串

-
- - - -
- (NSString *)getCurStreamStateName
- - - - - -
-

Return Value

-

当前状态名称

-
- - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  streamErrorCode -

- -
-
- -
- - -
-

当前推流的错误码

-
- - - -
@property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取推流失败的原因

当streamState 为KSYStreamStateError时可查询

KSYStreamErrorCode_KSYAUTHFAILED 除外

在streamState 为KSYStreamStateConnected 时查询到

状态变化后清0

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  streamStateChange -

- -
-
- -
- - -
-

发生推流状态变化时的回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange
- - - - - - - - - -
-

Discussion

-

参数为新状态

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– getKSYStreamErrorCodeName: -

- -
-
- -
- - -
-

获取错误码对应的字符串

-
- - - -
- (NSString *)getKSYStreamErrorCodeName:(KSYStreamErrorCode)code
- - - -
-

Parameters

- - - - - - - -
code

错误码

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– getCurKSYStreamErrorCodeName -

- -
-
- -
- - -
-

获取当前错误码对应的字符串

-
- - - -
- (NSString *)getCurKSYStreamErrorCodeName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  netStateCode -

- -
-
- -
- - -
-

当前推流的网络事件

-
- - - -
@property (nonatomic, readonly) KSYNetStateCode netStateCode
- - - - - - - - - -
-

Discussion

-

可以通过该属性查询网络状况

通知： -* KSYNetStateEventNotification 当检测到网络发生特定事件时SDK发出通知 -* 收到通知后，通过本属性查询具体事件类型

KSYNetStateEventNotification

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  videoFPSChange -

- -
-
- -
- - -
-

帧率应发生变化时的回调函数

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange
- - - - - - - - - -
-

Discussion

-

参数为建议设定的fps

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– initWithDefaultCfg -

- -
-
- -
- - -
-

初始化方法 （step1）

-
- - - -
- (instancetype)initWithDefaultCfg
- - - - - - - - - -
-

Discussion

-

初始化，将下列属性设置为默认值

- - -

Warning: KSYStreamerBase只支持单实例推流，构造多个实例会出现异常

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– startStream: -

- -
-
- -
- - -
-

启动推流 （step2）

-
- - - -
- (void)startStream:(NSURL *)url
- - - -
-

Parameters

- - - - - - - -
url

目标地址

-
- - - - - - - -
-

Discussion

-

实现直播功能时, url为 rtmp 服务器地址 “rtmp://xxx.xx/appname/streamKey"

设置完成推流参数之后，将媒体流推送到 publishURL 对应的地址

实现本地录制功能时, url为本地文件地址 “/var/xxx/xx.mp4”

本地录制支持mp4和flv两种输出格式, 通过url的文件后缀指定

推流参数主要是视频编码器，音视频码率的设置

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– stopStream -

- -
-
- -
- - -
-

停止推流 （step3）

-
- - - -
- (void)stopStream
- - - - - - - - - -
-

Discussion

-

断开网络连接 或停止文件写入

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– muteStream: -

- -
-
- -
- - -
-

静音推流 (仍然有音频输出发送, 只是音量为0)

-
- - - -
- (void)muteStream:(BOOL)bMute
- - - -
-

Parameters

- - - - - - - -
bMute

YES / ON

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processVideoSampleBuffer: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

Buffer to process

-
- - - - - - - -
-

Discussion

-

应当在开始推流前定期调用此接口，比如按照采集帧率调用

支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processVideoSampleBuffer:onComplete: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion
- - - -
-

Parameters

- - - - - - - - - - - - -
sampleBuffer

Buffer to process

completion

当前视频帧处理完成的回调

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processVideoPixelBuffer:timeInfo: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp
- - - -
-

Parameters

- - - - - - - - - - - - -
pixelBuffer

待编码的像素数据

timeStamp

待编码的时间戳

-
- - - - - - - -
-

Discussion

-

应当在开始推流前定期调用此接口，比如按照采集帧率调用

支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processVideoPixelBuffer:timeInfo:onComplete: -

- -
-
- -
- - -
-

处理一个视频帧(只支持编码前的原始图像数据)

-
- - - -
- (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - -
pixelBuffer

待编码的像素数据

timeStamp

待编码的时间戳

completion

当前视频帧处理完成的回调

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processAudioSampleBuffer: -

- -
-
- -
- - -
-

处理一段音频数据

-
- - - -
- (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer
- - - -
-

Parameters

- - - - - - - -
sampleBuffer

Buffer to process

-
- - - - - - - -
-

Discussion

-

应当在开始推流前定期调用此接口，与processVideoSampleBuffer 交错进行

Warning: 目前只支持 S16 格式的PCM数据

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processAudioData:nbSample:withFormat:timeinfo: -

- -
-
- -
- - -
-

处理一段音频数据

-
- - - -
- (void)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime *)pts
- - - -
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - -
pData

原始数据指针数组

len

数据的长度，单位为字节

fmt

原始数据的格式 (必须保证一次推流过程中数据格式不变)

pts

原始数据的时间戳

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– processMessageData: -

- -
-
- -
- - -
-

处理一个消息

-
- - - -
- (void)processMessageData:(NSDictionary *)messageData
- - - -
-

Parameters

- - - - - - - -
message

message to process

-
- - - - - - - -
-

Discussion

-

开始推流后发生相应事件时调用此接口 -@warning

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  clientAk -

- -
-
- -
- - -
-

获取当前用户的ak -@warnning 默认是空的，只有在需要鉴权时，才能获取到

-
- - - -
@property (nonatomic, assign) NSString *clientAk
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  expireDate -

- -
-
- -
- - -
-

获取当前SDK过期时间

-
- - - -
@property (nonatomic, assign) NSDate *expireDate
- - - - - - - - - -
-

Discussion

-

为nil时,可以永久使用不会过期 -@warnning sdk自行解析得到, 外部赋值无效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  streamID -

- -
-
- -
- - -
-

查询当前推流的事件ID

-
- - - -
@property (nonatomic, readonly) NSString *streamID
- - - - - - - - - -
-

Discussion

-

md5(hostURL+timestamp) 对本次推流活动的标识

timestamp 为建立连接时的事件戳

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– isStreaming -

- -
-
- -
- - -
-

查询当前是否处于推流状态 (建立连接中, 或连接中)

-
- - - -
- (BOOL)isStreaming
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  encodeVKbps -

- -
-
- -
- - -
-

查询当前编码的视频码率大小（每秒更新）

-
- - - -
@property (nonatomic, readonly) double encodeVKbps
- - - - - - - - - -
-

Discussion

-

该码率为编码器产生的视频码率大小，单位为kbps

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  encodeAKbps -

- -
-
- -
- - -
-

查询当前编码的音频码率大小（每秒更新）

-
- - - -
@property (nonatomic, readonly) double encodeAKbps
- - - - - - - - - -
-

Discussion

-

该码率为编码器产生的音频码率大小，单位为kbps

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  uploadedKByte -

- -
-
- -
- - -
-

查询本次推流发送的流量大小 (仅推流时有效)

-
- - - -
@property (nonatomic, readonly) int uploadedKByte
- - - - - - - - - -
-

Discussion

-

从开始推流到现在，发送出去的数据字节数，单位为KByte

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  currentUploadingKbps -

- -
-
- -
- - -
-

查询当前上传的码率大小 (每秒更新)

-
- - - -
@property (nonatomic, readonly) double currentUploadingKbps
- - - - - - - - - -
-

Discussion

-

该码率为实际上传的速度, 也就是每秒上传的字节数，单位为kbps

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  encodingFPS -

- -
-
- -
- - -
-

查询当前编码的平均视频帧率

-
- - - -
@property (nonatomic, readonly) double encodingFPS
- - - - - - - - - -
-

Discussion

-

采集设备的输出帧率为videoFPS，约等于编码的目标帧率

编码的视频帧率不会高于采集帧率，但是当CPU资源不足时，编码帧率会低于采集帧率

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  encodedFrames -

- -
-
- -
- - -
-

查询本次推流编码的视频总帧数

-
- - - -
@property (nonatomic, readonly) int encodedFrames
- - - - - - - - - -
-

Discussion

-

从开始推流到现在，编码过的视频总帧数

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  droppedVideoFrames -

- -
-
- -
- - -
-

查询本次推流发送的丢帧数量

-
- - - -
@property (nonatomic, readonly) int droppedVideoFrames
- - - - - - - - - -
-

Discussion

-

这里是指编码后，由于网络发送阻塞导致丢弃的帧数

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  qosInfo -

- -
-
- -
- - -
-

推流的qos信息

-
- - - -
@property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo
- - - - - - - - - -
-

Discussion

-

在推流过程中，查询当前推流qos信息

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  rtmpHostIP -

- -
-
- -
- - -
-

查询当前推流的rtmp服务器的主机IP

-
- - - -
@property (atomic, readonly) NSString *rtmpHostIP
- - - - - - - - - -
-

Discussion

-

开始推流之后获取才为有效IP, 之前为空字符串

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  shouldEnableKSYStatModule -

- -
-
- -
- - -
-

收集网络相关状态的日志，默认开启

-
- - - -
@property (nonatomic, assign) BOOL shouldEnableKSYStatModule
- - - - - - - - - -
-

Discussion

-

可开关

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  logBlock -

- -
-
- -
- - -
-

获取Streamer中与网络相关的日志

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
- - - - - - - - - -
-

Discussion

-

相关字段说明请联系金山云技术支持

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– takePhotoWithQuality:fileName: -

- -
-
- -
- - -
-

截图功能，目前只支持jpg格式

-
- - - -
- (void)takePhotoWithQuality:(CGFloat)jpegCompressionQuality fileName:(NSString *)filename
- - - -
-

Parameters

- - - - - - - - - - - - -
jpegCompressionQuality

设置图像的压缩比例

filename

图片的文件名

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– getSnapshotWithCompletion: -

- -
-
- -
- - -
-

获取当前编码的截图

-
- - - -
- (void)getSnapshotWithCompletion:(void ( ^ ) ( UIImage *))completion
- - - -
-

Parameters

- - - - - - - -
completion

通过完成代码块获取到截图完成的图像

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordURL -

- -
-
- -
- - -
-

旁路录像地址

-
- - - -
@property (nonatomic, readonly) NSURL *bypassRecordURL
- - - - - - - - - -
-

Discussion

-

开始录像后, 将直播的内容同步存储一份到本地文件 -eg: /private/var/mobile/Containers/Data/Application/APPID/tmp/test.mp4

如果只要存储本地文件,请继续使用原来的startStream接口

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– startBypassRecord: -

- -
-
- -
- - -
-

启动旁路录像

-
- - - -
- (BOOL)startBypassRecord:(NSURL *)url
- - - -
-

Parameters

- - - - - - - -
url

本地录像文件地址:/private/var/…./test.mp4

-
- - - -
-

Return Value

-

是否能尝试启动写入, 不能表明真正开始录像了,真正开始请确认bypassRecordState的值

-
- - - - - -
-

Discussion

-

启动推流后才能开始写入文件

文件中的内容和直播内容完全一致

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

– stopBypassRecord -

- -
-
- -
- - -
-

停止旁路录像

-
- - - -
- (void)stopBypassRecord
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordDuration -

- -
-
- -
- - -
-

旁路录像的文件时长

-
- - - -
@property (nonatomic, readonly) double bypassRecordDuration
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordState -

- -
-
- -
- - -
-

旁路录像的状态

-
- - - -
@property (nonatomic, readonly) KSYRecordState bypassRecordState
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordErrorCode -

- -
-
- -
- - -
-

旁路录像的错误码

-
- - - -
@property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordErrorName -

- -
-
- -
- - -
-

旁路录像的错误名称

-
- - - -
@property (nonatomic, readonly) NSString *bypassRecordErrorName
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  bypassRecordStateChange -

- -
-
- -
- - -
-

当旁路录制的状态变化时

-
- - - -
@property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange
- - - - - - - - - -
-

Discussion

-

只有设置 loop为NO时才有效, 在开始播放前设置有效

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  shouldEnableKSYDropModule -

- -
-
- -
- - -
-

是否允许编码前丢帧，默认开启 -@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启

-
- - - -
@property (nonatomic, assign) BOOL shouldEnableKSYDropModule
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  netReachability -

- -
-
- -
- - -
-

/ 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码)

-
- - - -
@property (nonatomic, readonly) KSYReachability *netReachability
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  netReachState -

- -
-
- -
- - -
-

是否能连通外网

-
- - - -
@property (nonatomic, readonly) KSYNetReachState netReachState
- - - - - - - - - -
-

Discussion

-

networkDetectURL为nil或未探测到结果前，该值为KSYNetReachState_Unknown

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
- -

  reachabilityDetectURL -

- -
-
- -
- - -
-

用于检测网络连通性的地址，默认使用地址为“www.baidu.com”

-
- - - -
@property (nonatomic, readwrite) NSString *reachabilityDetectURL
- - - - - - - -
-

Availability

-

Available in KSYLive_iOS 2.1.1 and later

-
- - - -
-

Discussion

-

用户可自定义地址，但不可设置无效地址，如果不清楚规则，建议使用默认值

设置为nil时，则关闭网络连通性的检测, netReachability为nil，netReachState为KSYNetReachState_Unknown

-
- - - - - - - -
-

Declared In

-

KSYStreamerBase.h

-
- - -
-
-
-
- -
- - - - - - - - -
-
+
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYTranscoder.html b/doc/docset/Contents/Resources/Documents/Classes/KSYTranscoder.html index a1c2625..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYTranscoder.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYTranscoder.html @@ -3,11 +3,11 @@ - KSYTranscoder Class Reference + - +
@@ -43,44 +43,10 @@

@@ -93,406 +59,15 @@

-

KSYTranscoder Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYTranscoder.h
- - -
- -

Overview

-

不同音视频文件格式间的转码

-
 1. 输入可以是本地文件/HTTP/RTMP/HLS
- 2. 输出只能是本地文件
- 3. 只提供不同封装格式间转换的功能，不涉及音视频编码格式的转换
- 4. 目前只支持单路音视频流的转换
- 5. 输出格式目前只支持FLV和MOV
-
-
- - - - -
- - - - - - -
-
- -

– startTranscode:outputFilePath: -

- -
-
- -
- - -
-

开始转换

-
- - - -
- (void)startTranscode:(NSURL *)inputFilePath outputFilePath:(NSURL *)outputFilePath
- - - -
-

Parameters

- - - - - - - - - - - - -
inputFilePath

输入文件路径

outputFilePath

输出文件路径

-
- - - - - - - - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

– stopTranscode -

- -
-
- -
- - -
-

停止转换

-
- - - -
- (void)stopTranscode
- - - - - - - - - -
-

Discussion

-

与startTransform配对调用，除Idle状态外，其他状态下结束转码时都需要调用，否则可能会造成内存泄露

-
- - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

  duration -

- -
-
- -
- - -
-

转换文件的总时长，单位是秒

-
- - - -
@property (nonatomic, readonly) float duration
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

  position -

- -
-
- -
- - -
-

当前转换位置，单位是秒

-
- - - -
@property (nonatomic, readonly) float position
- - - - - - - - - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

  progress -

- -
-
- -
- - -
-

转换进度

-
- - - -
@property (nonatomic, readonly) float progress
- - - - - - - - - -
-

Discussion

-

取值从0.0~1.0，大小为position/duration;

-
- - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

  transcodeState -

- -
-
- -
- - -
-

当前转码状况

-
- - - -
@property (nonatomic, readonly) KSYTranscodeState transcodeState
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取转码器的工作状况

通知： -* KSYTranscodeStateDidChangeNotification 当转码器状态发生变化时提供通知 -* 可通过userInfo获取转换后的状态，关键字为KSYTranscodeStateUserInfoKey -* 也可以收到通知后，通过本属性查询新的状态，并作出相应的动作

状态机转换： -* 创建转码对象后状态为KSYTranscodeState_Idle -* 只能在KSYTranscodeStateIdle状态下调用 startTranscode 方法, - - 成功状态转为KSYTranscodeStateTranscoding - - 失败则转为KSYTranscodeStateError -* 开始转码后 - - 转码完成状态转为KSYTranscodeStateCompleted - - 转码过程中出现问题状态转为KSYTranscodeStateError -* 调用 stopTranscode 可将状态转为KSYTranscodeStateIdle

-
- - - - - - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
- -

  transcodeErrorCode -

- -
-
- -
- - -
-

转码器的错误码

-
- - - -
@property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode
- - - - - - - - - -
-

Discussion

-

可以通过该属性获取转码失败的原因 -@discussion -* 当transcoderStatus为KSYTranscodeState_Error时可查询 -* 当transcoderStatus为其他值时，错误码为KSYTranscodingErrorCode_NONE

通知： - * KSYTranscodeStateDidChangeNotification 当转码器状态发生变化时提供通知 - * 可通过userInfo获取当前错误码，关键字为KSYTranscodeErrorCodeInfoKey

-
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYTranscoder.h

-
- - -
-
-
-
- -
- - - - -

diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYUIRecorderKit.html b/doc/docset/Contents/Resources/Documents/Classes/KSYUIRecorderKit.html index f16070d..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYUIRecorderKit.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYUIRecorderKit.html @@ -3,11 +3,11 @@ - KSYUIRecorderKit Class Reference + - +
@@ -45,44 +45,8 @@

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -95,186 +59,15 @@

-

KSYUIRecorderKit Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYUIRecorderKit.h
- - -
- - - - - - -
-
- -

– initWithScheme: -

- -
-
- -
- - -
- (instancetype)initWithScheme:(KSYPlayRecordScheme)scheme
- - -
-
-
- -

  contentView -

- -
-
- -
- - -
@property (nonatomic, readwrite) UIView *contentView
- - -
-
-
- -

– processWithTextureId:TextureSize:Time: -

- -
-
- -
- - -
- (void)processWithTextureId:(GLuint)InputTexture TextureSize:(CGSize)TextureSize Time:(CMTime)time
- - -
-
-
- -

– processAudioSampleBuffer: -

- -
-
- -
- - -
- (void)processAudioSampleBuffer:(CMSampleBufferRef)buf
- - -
-
-
- -

– processVideoSampleBuffer:timeInfo: -

- -
-
- -
- - -
- (void)processVideoSampleBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp
- - -
-
-
- -

– startRecord: -

- -
-
- -
- - -
- (void)startRecord:(NSURL *)path
- - -
-
-
- -

– stopRecord -

- -
-
- -
- - -
- (void)stopRecord
- - -
-
-
- -

  bPlayRecord -

- -
-
- -
- - -
@property BOOL bPlayRecord
- - -
-
-
- -

  writer -

- -
-
- -
- - -
@property (nonatomic, readwrite) KSYMovieWriter *writer
- - -
-
-
-
- -
- - - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYVideoInfo.html b/doc/docset/Contents/Resources/Documents/Classes/KSYVideoInfo.html index 2a6bee2..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYVideoInfo.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYVideoInfo.html @@ -3,11 +3,11 @@ - KSYVideoInfo Class Reference + - +
@@ -43,32 +43,10 @@

@@ -81,173 +59,15 @@

-

KSYVideoInfo Class Reference

+

-
- - - - - - - -
Inherits fromNSObject
Declared inKSYMediaInfo.h
- - -
- -

Overview

-

视频信息

-
- - - - - -
- - - - - - -
-
- -

  vcodec -

- -
-
- -
- - -
-

视频编码格式, 具体类型为MEDIAINFO_CODEC_ID

-
- - - -
@property (nonatomic) MEDIAINFO_CODEC_ID vcodec
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  frame_width -

- -
-
- -
- - -
-

视频帧宽度

-
- - - -
@property (nonatomic, assign) int32_t frame_width
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
- -

  frame_height -

- -
-
- -
- - -
-

视频帧高度

-
- - - -
@property (nonatomic, assign) int32_t frame_height
- - - - - - - - - - - - - - -
-

Declared In

-

KSYMediaInfo.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Classes/KSYWeakProxy.html b/doc/docset/Contents/Resources/Documents/Classes/KSYWeakProxy.html index 38de4fb..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Classes/KSYWeakProxy.html +++ b/doc/docset/Contents/Resources/Documents/Classes/KSYWeakProxy.html @@ -3,11 +3,11 @@ - KSYWeakProxy Class Reference + - +
@@ -43,40 +43,10 @@

@@ -89,223 +59,15 @@

-

KSYWeakProxy Class Reference

+

-
- - - - - - - -
Inherits fromNSProxy
Declared inKSYWeakProxy.h
- - -
- -

Overview

-

A proxy used to hold a weak object. -It can be used to avoid retain cycles, such as the target in NSTimer or CADisplayLink.

- -

sample code:

- -
 @implementation ViewController {
-    NSTimer *_timer;
- }
-
- - (void)initTimer {
-    KSYWeakProxy *proxy = [KSYWeakProxy proxyWithTarget:self];
-    _timer = [NSTimer timerWithTimeInterval:0.1 target:proxy selector:@selector(tick:) userInfo:nil repeats:YES];
- }
-
- - (void)tick:(NSTimer *)timer {...}
- @end
-
-
- - - - - -
- - - - - - -
-
- -

  target -

- -
-
- -
- - -
-

The proxy target.

-
- - - -
@property (nullable, nonatomic, weak, readonly) id target
- - - - - - - - - - - - - - - -
-

Declared In

-

KSYWeakProxy.h

-
- - -
-
-
- -

– initWithTarget: -

- -
-
- -
- - -
-

Creates a new weak proxy for target.

-
- - - -
- (instancetype)initWithTarget:(id)target
- - - -
-

Parameters

- - - - - - - -
target

Target object.

-
- - - -
-

Return Value

-

A new proxy object.

-
- - - - - - - - - - -
-

Declared In

-

KSYWeakProxy.h

-
- - -
-
-
- -

+ proxyWithTarget: -

- -
-
- -
- - -
-

Creates a new weak proxy for target.

-
- - - -
+ (instancetype)proxyWithTarget:(id)target
- - - -
-

Parameters

- - - - - - - -
target

Target object.

-
- - - -
-

Return Value

-

A new proxy object.

-
- - - - - - - - - - - -
-

Declared In

-

KSYWeakProxy.h

-
- - -
-
-
-
- -
- - -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYAVMuxerStatus.html b/doc/docset/Contents/Resources/Documents/Constants/KSYAVMuxerStatus.html index 4b2e018..42c33b5 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYAVMuxerStatus.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYAVMuxerStatus.html @@ -3,11 +3,11 @@ - KSYAVMuxerStatus Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYAVMuxerStatus Constants Reference

+

-
- - - - -
Declared inKSYAVMuxer.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

@@ -166,7 +159,7 @@

Constants

- Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

@@ -183,7 +176,7 @@

Constants

- Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

@@ -199,14 +192,12 @@

Constants

-

Declared In

+

KSYAVMuxer.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioCodec.html b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioCodec.html index ab382c7..ca6e1e9 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioCodec.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioCodec.html @@ -3,11 +3,11 @@ - KSYAudioCodec Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYAudioCodec Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -147,7 +140,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -164,7 +157,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -180,14 +173,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioEffectType.html b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioEffectType.html index 05f90c0..e4c2b7f 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioEffectType.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioEffectType.html @@ -3,11 +3,11 @@ - KSYAudioEffectType Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYAudioEffectType Constants Reference

+

-
- - - - -
Declared inKSYAUAudioCapture.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -166,7 +159,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -183,7 +176,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -199,14 +192,12 @@

Constants

-

Declared In

+

KSYAUAudioCapture.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioNoiseSuppress.html b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioNoiseSuppress.html index acba38f..b50e1f4 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYAudioNoiseSuppress.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYAudioNoiseSuppress.html @@ -3,11 +3,11 @@ - KSYAudioNoiseSuppress Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYAudioNoiseSuppress Constants Reference

+

-
- - - - -
Declared inKSYAUAudioCapture.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -166,7 +159,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -183,7 +176,7 @@

Constants

- Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

@@ -199,14 +192,12 @@

Constants

-

Declared In

+

KSYAUAudioCapture.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYBWEstimateMode.html b/doc/docset/Contents/Resources/Documents/Constants/KSYBWEstimateMode.html index 2532f5f..464bd04 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYBWEstimateMode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYBWEstimateMode.html @@ -3,11 +3,11 @@ - KSYBWEstimateMode Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYBWEstimateMode Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -111,7 +104,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -128,7 +121,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -145,7 +138,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -161,14 +154,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYBgmPlayerState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYBgmPlayerState.html index b379964..e091618 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYBgmPlayerState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYBgmPlayerState.html @@ -3,11 +3,11 @@ - KSYBgmPlayerState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYBgmPlayerState Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -119,7 +112,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -136,7 +129,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -153,7 +146,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -170,7 +163,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -187,7 +180,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -204,7 +197,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -221,7 +214,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -237,14 +230,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYCaptureState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYCaptureState.html index 5f1b20c..37ddf40 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYCaptureState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYCaptureState.html @@ -3,11 +3,11 @@ - KSYCaptureState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYCaptureState Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -117,7 +110,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -134,7 +127,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -151,7 +144,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -185,7 +178,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -202,7 +195,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -218,14 +211,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYDevAuthStatus.html b/doc/docset/Contents/Resources/Documents/Constants/KSYDevAuthStatus.html index 64f20cd..4524aa4 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYDevAuthStatus.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYDevAuthStatus.html @@ -3,11 +3,11 @@ - KSYDevAuthStatus Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYDevAuthStatus Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -117,7 +110,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -134,7 +127,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -151,7 +144,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -184,14 +177,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYLiveScene.html b/doc/docset/Contents/Resources/Documents/Constants/KSYLiveScene.html index 28face6..27cdf64 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYLiveScene.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYLiveScene.html @@ -3,11 +3,11 @@ - KSYLiveScene Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYLiveScene Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -165,14 +158,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYMPErrorCode.html b/doc/docset/Contents/Resources/Documents/Constants/KSYMPErrorCode.html index d6497a0..d37a3f1 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYMPErrorCode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYMPErrorCode.html @@ -3,11 +3,11 @@ - KSYMPErrorCode Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYMPErrorCode Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -151,7 +144,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -185,7 +178,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -202,7 +195,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -219,7 +212,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -236,7 +229,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -253,7 +246,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -270,7 +263,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -287,7 +280,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -304,7 +297,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -321,7 +314,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -338,7 +331,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -355,7 +348,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -372,7 +365,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -389,7 +382,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -406,7 +399,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -423,7 +416,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -440,7 +433,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -457,7 +450,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -474,7 +467,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -491,7 +484,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -507,14 +500,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYMicType.html b/doc/docset/Contents/Resources/Documents/Constants/KSYMicType.html index aa1e3ed..661e545 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYMicType.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYMicType.html @@ -3,11 +3,11 @@ - KSYMicType Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYMicType Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -117,7 +110,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -134,7 +127,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -151,7 +144,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -184,14 +177,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYNetReachState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYNetReachState.html index af202b2..df9c929 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYNetReachState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYNetReachState.html @@ -3,11 +3,11 @@ - KSYNetReachState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYNetReachState Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -111,7 +104,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -128,7 +121,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -145,7 +138,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -161,14 +154,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYNetStateCode.html b/doc/docset/Contents/Resources/Documents/Constants/KSYNetStateCode.html index 6ca5057..d1ab0e9 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYNetStateCode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYNetStateCode.html @@ -3,11 +3,11 @@ - KSYNetStateCode Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYNetStateCode Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -125,7 +118,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -142,7 +135,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -159,7 +152,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -176,7 +169,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -193,7 +186,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -210,7 +203,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -227,7 +220,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -244,7 +237,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -261,7 +254,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -278,7 +271,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -294,14 +287,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYNetworkStatus.html b/doc/docset/Contents/Resources/Documents/Constants/KSYNetworkStatus.html index f0e5599..bb92163 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYNetworkStatus.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYNetworkStatus.html @@ -3,11 +3,11 @@ - KSYNetworkStatus Constants Reference + - +
@@ -59,19 +59,9 @@

-

KSYNetworkStatus Constants Reference

+

-
- - - - - - - -
Declared inKSYReachability.h
Referenceshttp://nshipster.com/ns_enum-ns_options/
- @@ -118,7 +108,7 @@

Constants

- Declared In KSYReachability.h. + KSYReachability.h.

@@ -135,7 +125,7 @@

Constants

- Declared In KSYReachability.h. + KSYReachability.h.

@@ -152,7 +142,7 @@

Constants

- Declared In KSYReachability.h. + KSYReachability.h.

@@ -166,25 +156,21 @@

Constants

-

See Also

+

-

Declared In

+

KSYReachability.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYPlayRecordScheme.html b/doc/docset/Contents/Resources/Documents/Constants/KSYPlayRecordScheme.html index f7ff606..85f87e0 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYPlayRecordScheme.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYPlayRecordScheme.html @@ -3,11 +3,11 @@ - KSYPlayRecordScheme Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYPlayRecordScheme Constants Reference

+

-
- - - - -
Declared inKSYUIRecorderKit.h
- @@ -109,7 +102,7 @@

Constants

- Declared In KSYUIRecorderKit.h. + KSYUIRecorderKit.h.

@@ -126,7 +119,7 @@

Constants

- Declared In KSYUIRecorderKit.h. + KSYUIRecorderKit.h.

@@ -142,14 +135,12 @@

Constants

-

Declared In

+

KSYUIRecorderKit.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYRecScene.html b/doc/docset/Contents/Resources/Documents/Constants/KSYRecScene.html index 806a303..184834c 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYRecScene.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYRecScene.html @@ -3,11 +3,11 @@ - KSYRecScene Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYRecScene Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -146,14 +139,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYRecordError.html b/doc/docset/Contents/Resources/Documents/Constants/KSYRecordError.html index badb7bb..55079d1 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYRecordError.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYRecordError.html @@ -3,11 +3,11 @@ - KSYRecordError Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYRecordError Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -147,7 +140,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -164,7 +157,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -180,14 +173,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYRecordState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYRecordState.html index 583f1ed..09d9cb4 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYRecordState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYRecordState.html @@ -3,11 +3,11 @@ - KSYRecordState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYRecordState Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -147,7 +140,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -164,7 +157,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -180,14 +173,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYStreamErrorCode.html b/doc/docset/Contents/Resources/Documents/Constants/KSYStreamErrorCode.html index 2924aa3..8a71796 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYStreamErrorCode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYStreamErrorCode.html @@ -3,11 +3,11 @@ - KSYStreamErrorCode Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYStreamErrorCode Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -177,7 +170,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -194,7 +187,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -211,7 +204,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -228,7 +221,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -245,7 +238,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -262,7 +255,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -279,7 +272,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -296,7 +289,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -313,7 +306,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -330,7 +323,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -347,7 +340,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -364,7 +357,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -381,7 +374,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -398,7 +391,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -415,7 +408,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -432,7 +425,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -449,7 +442,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -466,7 +459,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -483,7 +476,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -500,7 +493,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -517,7 +510,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -534,7 +527,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -551,7 +544,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -568,7 +561,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -585,7 +578,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -602,7 +595,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -619,7 +612,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -636,7 +629,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -653,7 +646,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -670,7 +663,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -687,7 +680,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -704,7 +697,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -721,7 +714,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -738,7 +731,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -755,7 +748,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -772,7 +765,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -788,14 +781,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYStreamState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYStreamState.html index 2629cec..95aa7cc 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYStreamState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYStreamState.html @@ -3,11 +3,11 @@ - KSYStreamState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYStreamState Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -166,7 +159,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -183,7 +176,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -199,14 +192,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeErrorCode.html b/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeErrorCode.html index 9d37068..a8481bc 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeErrorCode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeErrorCode.html @@ -3,11 +3,11 @@ - KSYTranscodeErrorCode Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYTranscodeErrorCode Constants Reference

+

-
- - - - -
Declared inKSYTranscoder.h
- @@ -123,7 +116,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -140,7 +133,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -157,7 +150,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -174,7 +167,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -191,7 +184,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -208,7 +201,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -225,7 +218,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -242,7 +235,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -259,7 +252,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -275,14 +268,12 @@

Constants

-

Declared In

+

KSYTranscoder.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeState.html b/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeState.html index b446b7f..5bc0140 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeState.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYTranscodeState.html @@ -3,11 +3,11 @@ - KSYTranscodeState Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYTranscodeState Constants Reference

+

-
- - - - -
Declared inKSYTranscoder.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -147,7 +140,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -164,7 +157,7 @@

Constants

- Declared In KSYTranscoder.h. + KSYTranscoder.h.

@@ -180,14 +173,12 @@

Constants

-

Declared In

+

KSYTranscoder.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoCodec.html b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoCodec.html index 4bd78d0..5588ee8 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoCodec.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoCodec.html @@ -3,11 +3,11 @@ - KSYVideoCodec Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYVideoCodec Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -91,6 +84,8 @@

Definition

   KSYVideoCodec_VT264,
+    KSYVideoCodec_VT265,
+    KSYVideoCodec_AUTO = 100,
   KSYVideoCodec_GIF,
@@ -115,7 +110,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -132,7 +127,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -149,7 +144,24 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h. +

+ + + +
KSYVideoCodec_VT265
+
+ + +

视频编码器 - iOS VT265硬件编码器 (iOS 11.0 以上)

+ + + + + + +

+ KSYTypeDef.h.

@@ -166,7 +178,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -183,7 +195,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -199,14 +211,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoDimension.html b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoDimension.html index 9a05610..efe49c9 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoDimension.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoDimension.html @@ -3,11 +3,11 @@ - KSYVideoDimension Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYVideoDimension Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -125,7 +118,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -142,7 +135,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -159,7 +152,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -176,7 +169,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -193,7 +186,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -210,7 +203,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -227,7 +220,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -244,7 +237,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -260,14 +253,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoEncodePerformance.html b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoEncodePerformance.html index 02670dd..9430a8a 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSYVideoEncodePerformance.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSYVideoEncodePerformance.html @@ -3,11 +3,11 @@ - KSYVideoEncodePerformance Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSYVideoEncodePerformance Constants Reference

+

-
- - - - -
Declared inKSYTypeDef.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYTypeDef.h. + KSYTypeDef.h.

@@ -165,14 +158,12 @@

Constants

-

Declared In

+

KSYTypeDef.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/KSY_NETTRACKER_ACTION.html b/doc/docset/Contents/Resources/Documents/Constants/KSY_NETTRACKER_ACTION.html index e0e126f..fc6f8b4 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/KSY_NETTRACKER_ACTION.html +++ b/doc/docset/Contents/Resources/Documents/Constants/KSY_NETTRACKER_ACTION.html @@ -3,11 +3,11 @@ - KSY_NETTRACKER_ACTION Constants Reference + - +
@@ -59,16 +59,9 @@

-

KSY_NETTRACKER_ACTION Constants Reference

+

-
- - - - -
Declared inKSYNetTracker.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYNetTracker.h. + KSYNetTracker.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYNetTracker.h. + KSYNetTracker.h.

@@ -146,14 +139,12 @@

Constants

-

Declared In

+

KSYNetTracker.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_CODEC_ID.html b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_CODEC_ID.html index d8a44de..752ee67 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_CODEC_ID.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_CODEC_ID.html @@ -3,11 +3,11 @@ - MEDIAINFO_CODEC_ID Constants Reference + - +
@@ -59,16 +59,9 @@

-

MEDIAINFO_CODEC_ID Constants Reference

+

-
- - - - -
Declared inKSYMediaInfo.h
- @@ -139,7 +132,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -156,7 +149,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -173,7 +166,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -190,7 +183,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -207,7 +200,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -224,7 +217,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -241,7 +234,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -258,7 +251,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -275,7 +268,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -292,7 +285,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -309,7 +302,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -326,7 +319,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -343,7 +336,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -360,7 +353,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -377,7 +370,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -393,14 +386,12 @@

Constants

-

Declared In

+

KSYMediaInfo.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_MUX_TYPE.html b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_MUX_TYPE.html index f73c812..905f4ae 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_MUX_TYPE.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_MUX_TYPE.html @@ -3,11 +3,11 @@ - MEDIAINFO_MUX_TYPE Constants Reference + - +
@@ -59,16 +59,9 @@

-

MEDIAINFO_MUX_TYPE Constants Reference

+

-
- - - - -
Declared inKSYMediaInfo.h
- @@ -135,7 +128,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -152,7 +145,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -169,7 +162,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -186,7 +179,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -203,7 +196,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -220,7 +213,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -237,7 +230,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -254,7 +247,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -271,7 +264,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -288,7 +281,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -305,7 +298,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -322,7 +315,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -339,7 +332,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -355,14 +348,12 @@

Constants

-

Declared In

+

KSYMediaInfo.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_SAMPLE_FMT.html b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_SAMPLE_FMT.html index 2e5ebd3..d9f7dc8 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_SAMPLE_FMT.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MEDIAINFO_SAMPLE_FMT.html @@ -3,11 +3,11 @@ - MEDIAINFO_SAMPLE_FMT Constants Reference + - +
@@ -59,16 +59,9 @@

-

MEDIAINFO_SAMPLE_FMT Constants Reference

+

-
- - - - -
Declared inKSYMediaInfo.h
- @@ -133,7 +126,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -150,7 +143,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -167,7 +160,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -184,7 +177,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -201,7 +194,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -218,7 +211,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -235,7 +228,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -252,7 +245,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -269,7 +262,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -286,7 +279,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -303,7 +296,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -320,7 +313,7 @@

Constants

- Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

@@ -336,14 +329,12 @@

Constants

-

Declared In

+

KSYMediaInfo.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieAudioPan.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieAudioPan.html index 9264a40..5a82055 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieAudioPan.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieAudioPan.html @@ -3,11 +3,11 @@ - MPMovieAudioPan Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieAudioPan Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -115,7 +108,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -132,7 +125,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -149,7 +142,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -165,14 +158,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieMetaType.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieMetaType.html index c7c89dc..42620e0 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieMetaType.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieMetaType.html @@ -3,11 +3,11 @@ - MPMovieMetaType Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieMetaType Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -117,7 +110,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -134,7 +127,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -151,7 +144,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -184,14 +177,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieReloadMode.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieReloadMode.html index bcc608f..4f9fb8d 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieReloadMode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieReloadMode.html @@ -3,11 +3,11 @@ - MPMovieReloadMode Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieReloadMode Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -146,14 +139,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieStatus.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieStatus.html index c9ffaf4..18dd9ad 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieStatus.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieStatus.html @@ -3,11 +3,11 @@ - MPMovieStatus Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieStatus Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -119,7 +112,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -136,7 +129,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -153,7 +146,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -170,7 +163,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -187,7 +180,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -203,14 +196,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDecoderMode.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDecoderMode.html index 855b1cf..3228e26 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDecoderMode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDecoderMode.html @@ -3,11 +3,11 @@ - MPMovieVideoDecoderMode Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieVideoDecoderMode Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -117,7 +110,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -134,7 +127,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -151,7 +144,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -168,7 +161,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -184,14 +177,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDeinterlaceMode.html b/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDeinterlaceMode.html index dc6dc9f..888db6a 100644 --- a/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDeinterlaceMode.html +++ b/doc/docset/Contents/Resources/Documents/Constants/MPMovieVideoDeinterlaceMode.html @@ -3,11 +3,11 @@ - MPMovieVideoDeinterlaceMode Constants Reference + - +
@@ -59,16 +59,9 @@

-

MPMovieVideoDeinterlaceMode Constants Reference

+

-
- - - - -
Declared inKSYMoviePlayerDefines.h
- @@ -113,7 +106,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -130,7 +123,7 @@

Constants

- Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

@@ -146,14 +139,12 @@

Constants

-

Declared In

+

KSYMoviePlayerDefines.h

- -
diff --git a/doc/docset/Contents/Resources/Documents/Protocols/KSYMediaPlayback.html b/doc/docset/Contents/Resources/Documents/Protocols/KSYMediaPlayback.html index 237028d..4e8eace 100644 --- a/doc/docset/Contents/Resources/Documents/Protocols/KSYMediaPlayback.html +++ b/doc/docset/Contents/Resources/Documents/Protocols/KSYMediaPlayback.html @@ -3,11 +3,11 @@ - KSYMediaPlayback Protocol Reference + - +
@@ -43,42 +43,10 @@

@@ -91,451 +59,15 @@

-

KSYMediaPlayback Protocol Reference

+

-
- - - - -
Declared inKSYMediaPlayback.h
- - -
- -

Overview

-

KSYMediaPlayback为播放内核KSYMoviePlayerController提供播放控制功能。

- -

联系我们

- -

当本文档无法帮助您解决在开发中遇到的具体问题，请通过以下方式联系我们，金山云工程师会在第一时间回复您。

- -

E-mail: zengfanping@kingsoft.com

-
- - - - - -
- - - - - - -
-
- -

– prepareToPlay -required method

- -
-
- -
- - -
-

准备视频播放

-
- - - -
- (void)prepareToPlay
- - - - - - - - - -
-

Discussion

-

prepareToPlay处理逻辑

- -
    -
  • 如果isPreparedToPlay为FALSE，直接调用play，则在play内部自动调用prepareToPlay接口。
    • -
  • prepareToPlay调用后，由MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知完成准备工作。查询isPreparedToPlay可以获得具体属性值。
    • -
-

通知类型

- -
    -
  • MPMediaPlaybackIsPreparedToPlayDidChangeNotification， 播放器完成对视频文件的初始化时发送通知
    • -
- -
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
- -

  isPreparedToPlay -required method

- -
-
- -
- - -
-

查询视频准备是否完成

-
- - - -
@property (nonatomic, readonly) BOOL isPreparedToPlay
- - - - - - - - -
-

Discussion

-

isPreparedToPlay处理逻辑

- -
    -
  • 如果isPreparedToPlay为TRUE，则可以调用play接口开始播放;
    • -
  • 如果isPreparedToPlay为FALSE，则需要调用prepareToPlay接口开始准备工作；
    • -
  • 如果isPreparedToPlay为FALSE，直接调用play，则在play内部自动调用prepareToPlay接口。
    • -
- -
- - - - - -
-

See Also

- -
- - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
- -

– play -required method

- -
-
- -
- - -
-

播放当前视频。

-
- - - -
- (void)play
- - - - - - - -
-

Availability

-

Available in KSYMediaPlayback 1.0 and later.

-
- - - -
-

Discussion

-

play的使用逻辑:

- -
    -
  • 如果调用play方法前已经调用prepareToPlay完成播放器对视频文件的初始化，且shouldAutoplay属性为NO，则调用play方法将开始播放当前视频。此时播放器状态为CBPMoviePlaybackStatePlaying。
    • -
  • 如果调用play方法前已经调用prepareToPlay完成播放器对视频文件的初始化，且shouldAutoplay属性为YES，则调用play方法将暂停播放当前视频，实现效果和pause一致。
    • -
  • 如果调用play方法前未调用prepareToPlay完成播放器对视频文件的初始化，则播放器自动调用prepareToPlay进行视频文件的初始化工作。
    • -
  • 如果调用play方法前已经调用pause暂停了正在播放的视频，则重新开始启动播放视频。
    • -
- -
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
- -

– pause -required method

- -
-
- -
- - -
-

暂停播放当前视频。

-
- - - -
- (void)pause
- - - - - - - -
-

Availability

-

Available in KSYMediaPlayback 1.0 and later.

-
- - - -
-

Discussion

-

pause调用逻辑：

- -
    -
  • 如果当前视频播放已经暂停，调用该方法将不产生任何效果。
    • -
  • 重新回到播放状态，需要调用play方法。
    • -
  • 如果调用pause方法后视频暂停播放，此时播放器状态处于CBPMoviePlaybackStatePaused。
    • -
  • 播放器内部监听了UIApplicationWillEnterForegroundNotification通知，该通知发生时如果视频仍然在播放，将自动调用pause暂停当前视频播放。
    • -
-

后台播放逻辑：

- -
    -
  • 需要APP有后台执行权限，在工程Info.plist中添加后台运行模式，设置为audio。具体是添加UIBackgroundModes项，值为audio。
    • -
  • 当用户点击home按钮后，播放器进入后台继续读取数据并播放音频。
    • -
  • 当APP回到前台后，音频继续播放。图像渲染内容保持和音频同步。
    • -
  • 如果在开启后台运行模式后，需要切换后台暂停，需要监听相关事件并主动调用pause操作。
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
- -

– stop -required method

- -
-
- -
- - -
-

结束当前视频的播放。

-
- - - -
- (void)stop
- - - - - - - -
-

Availability

-

Available in KSYMediaPlayback 1.0 and later.

-
- - - -
-

Discussion

-

stop调用逻辑：

- -
    -
  • 调用stop结束当前播放，如果需要重新播放该视频，需要调用prepareToPlay方法。
    • -
  • 调用stop方法后，播放器开始进入关闭当前播放的操作，操作完成将发送MPMoviePlayerPlaybackDidFinishNotification通知。
    • -
-

通知：

- -
    -
  • MPMoviePlayerPlaybackDidFinishNotification， 当播放完成将发送该通知。
    • -
- -
- - - - - -
-

See Also

- -
- - - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
- -

  currentPlaybackTime -required method

- -
-
- -
- - -
-

播放视频的当前时刻，单位为秒。

-
- - - -
@property (nonatomic) NSTimeInterval currentPlaybackTime
- - - - - - - -
-

Availability

-

Available in KSYMediaPlayback 1.0 and later.

-
- - - -
-

Discussion

-

currentPlaybackTime属性更改时机：

- -
    -
  • 视频正常播放时，如果改变currentPlaybackTime的值，将导致播放行为跳转到新的currentPlaybackTime位置播放。
    • -
  • 在调用prepareToPlay之前设置该属性的值无效，若希望从指定位置开始播放，需要以下设置 - -
      -
    • 将player的自动播放属性shouldAutoplay设置为NO;
      • -
    • 监听到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知时，将currentPlaybackTime设置为期望开始播放的时间点，单位是秒
      • -
    • 调用play方法，即可从指定位置开始播放
      • -
    -
    • -
- -
- - - - - - - -
-

Declared In

-

KSYMediaPlayback.h

-
- - -
-
-
-
- -
- - - - -
diff --git a/doc/docset/Contents/Resources/Documents/css/scss/_index.scss b/doc/docset/Contents/Resources/Documents/css/scss/_index.scss index 6a57ec5..7e98029 100644 --- a/doc/docset/Contents/Resources/Documents/css/scss/_index.scss +++ b/doc/docset/Contents/Resources/Documents/css/scss/_index.scss @@ -1,17 +1,13 @@ .index-container { - -webkit-flex-direction: column; - flex-direction: column; + display: flex; + flex-direction: row; + flex-wrap: wrap; - @media (min-width: $desktop-min-width) { - display: flex; - -webkit-flex-direction: row; - flex-direction: row; - -webkit-flex-wrap: wrap; - flex-wrap: wrap; + @media (max-width: $mobile-max-width) { + flex-direction: column; } .index-column { - -webkit-flex: 1 1 33%; flex: 1 1 33%; } } diff --git a/doc/docset/Contents/Resources/Documents/css/scss/_layout.scss b/doc/docset/Contents/Resources/Documents/css/scss/_layout.scss index da46aef..40bd6d4 100644 --- a/doc/docset/Contents/Resources/Documents/css/scss/_layout.scss +++ b/doc/docset/Contents/Resources/Documents/css/scss/_layout.scss @@ -21,10 +21,6 @@ body { font: 62.5% $body-font; background: $body-background; - - @media (max-width: $mobile-max-width) { - background-color: $content-background; - } } h1, h2, h3 { @@ -143,6 +139,8 @@ header { } @media (max-width: $mobile-max-width) { + position: absolute; + .container { padding: 0 10px; } @@ -159,6 +157,10 @@ aside { font-size: 1.1em; + @media (max-width: $mobile-max-width) { + position: absolute; + } + #header-buttons { background: rgba(255, 255, 255, .8); margin: 0 1px; @@ -235,7 +237,6 @@ article { @media (max-width: $mobile-max-width) { padding: 15px 10px 20px 10px; - border: none; } .navigation-top { diff --git a/doc/docset/Contents/Resources/Documents/css/scss/_variables.scss b/doc/docset/Contents/Resources/Documents/css/scss/_variables.scss index 38e072d..cbaff3c 100644 --- a/doc/docset/Contents/Resources/Documents/css/scss/_variables.scss +++ b/doc/docset/Contents/Resources/Documents/css/scss/_variables.scss @@ -9,4 +9,3 @@ $object-background: #f9f9f9; $object-border: #e9e9e9; $mobile-max-width: 650px; -$desktop-min-width: 768px; \ No newline at end of file diff --git a/doc/docset/Contents/Resources/Documents/css/style.css b/doc/docset/Contents/Resources/Documents/css/style.css deleted file mode 100644 index d9d59dd..0000000 --- a/doc/docset/Contents/Resources/Documents/css/style.css +++ /dev/null @@ -1,2 +0,0 @@ -html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}@media (max-width: 650px){body{background-color:#fff}}h1,h2,h3{font-weight:300;color:#808080}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:"Source Code Pro",Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,0.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media (max-width: 650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media (max-width: 650px){header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,0.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;transform:rotateZ(45deg) scale(0.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;transform:rotateZ(-45deg) scale(0.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px 25px;font-size:1.4em;line-height:1.45;position:relative}@media (max-width: 650px){article #content{padding:15px 10px 20px 10px;border:none}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px 0}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{-webkit-flex-direction:column;flex-direction:column}@media (min-width: 768px){.index-container{display:flex;-webkit-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;flex-wrap:wrap}}.index-container .index-column{-webkit-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0 25px;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px -25px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);transform:rotate(45deg) }.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:#808080;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0 !important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .method-info,.section-method.hide .xcode .method-info{max-height:auto;overflow:visible}.xcode .method-info.hiding,.section-method.hide .xcode .method-info.hiding{display:block} - diff --git a/doc/docset/Contents/Resources/Documents/hierarchy.html b/doc/docset/Contents/Resources/Documents/hierarchy.html index f3933c5..e952996 100644 --- a/doc/docset/Contents/Resources/Documents/hierarchy.html +++ b/doc/docset/Contents/Resources/Documents/hierarchy.html @@ -3,11 +3,11 @@ - KSYLive_iOS Hierarchy + - +
@@ -38,11 +38,11 @@

-

KSYLive_iOS Hierarchy

+

-

Class Hierarchy

+

@@ -75,6 +77,8 @@

Class Hierarchy

  • KSYBeautifyProFilter
    • +
  • KSYMvFilter
    • +
  • KSYSpecialEffects
    • diff --git a/doc/docset/Contents/Resources/Documents/index.html b/doc/docset/Contents/Resources/Documents/index.html index c737493..c10ec9e 100644 --- a/doc/docset/Contents/Resources/Documents/index.html +++ b/doc/docset/Contents/Resources/Documents/index.html @@ -3,11 +3,11 @@ - KSYLive_iOS Reference + - +
    @@ -38,7 +38,7 @@

    -

    KSYLive_iOS Reference

    +

    @@ -47,7 +47,7 @@

    KSYLive_iOS Reference

    -

    Class References

    +

    diff --git a/doc/docset/Contents/Resources/Documents/js/script.js b/doc/docset/Contents/Resources/Documents/js/script.js index 4074361..ca915ee 100644 --- a/doc/docset/Contents/Resources/Documents/js/script.js +++ b/doc/docset/Contents/Resources/Documents/js/script.js @@ -46,11 +46,10 @@ function fixScrollPosition(element) { info.style.height = (infoContainer.clientHeight + 40) + "px"; fixScrollPosition(element); element.classList.toggle("hide"); - if (element.classList.contains("hide")) { - e.preventDefault(); - } + setTimeout(function() { element.classList.remove("animating"); + info.style.height = "auto"; }, 300); }); }); diff --git a/doc/docset/Contents/Resources/Nodes.xml b/doc/docset/Contents/Resources/Nodes.xml index 16f0bb2..48a6dfa 100644 --- a/doc/docset/Contents/Resources/Nodes.xml +++ b/doc/docset/Contents/Resources/Nodes.xml @@ -58,6 +58,8 @@ + + @@ -67,7 +69,7 @@ Categories index.html - + @@ -77,7 +79,7 @@ Protocols index.html - + @@ -87,8 +89,6 @@ Constants index.html - - @@ -122,6 +122,8 @@ + + @@ -131,13 +133,13 @@ Blocks index.html - - + + @@ -1307,6 +1309,66 @@ + KSYMvEffect + Classes/KSYMvEffect.html + + + + Classes/KSYMvEffect.html + Overview + overview + + + Classes/KSYMvEffect.html + Tasks + tasks + + + + + + Classes/KSYMvEffect.html + Instance Methods + instance_methods + + + + + + + KSYMvFilter + Classes/KSYMvFilter.html + + + + Classes/KSYMvFilter.html + Overview + overview + + + Classes/KSYMvFilter.html + Tasks + tasks + + + + Classes/KSYMvFilter.html + Properties + properties + + + + + + Classes/KSYMvFilter.html + Instance Methods + instance_methods + + + + + + KSYNetRouterInfo Classes/KSYNetRouterInfo.html @@ -1333,7 +1395,7 @@ - + KSYNetTracker Classes/KSYNetTracker.html @@ -1366,7 +1428,7 @@ - + KSYQosInfo Classes/KSYQosInfo.html @@ -1393,7 +1455,7 @@ - + KSYReachability Classes/KSYReachability.html @@ -1432,7 +1494,7 @@ - + KSYSpecialEffects Classes/KSYSpecialEffects.html @@ -1471,7 +1533,7 @@ - + KSYStreamerBase Classes/KSYStreamerBase.html @@ -1504,7 +1566,7 @@ - + KSYTranscoder Classes/KSYTranscoder.html @@ -1537,7 +1599,7 @@ - + KSYUIRecorderKit Classes/KSYUIRecorderKit.html @@ -1570,7 +1632,7 @@ - + KSYVideoInfo Classes/KSYVideoInfo.html @@ -1597,7 +1659,7 @@ - + KSYWeakProxy Classes/KSYWeakProxy.html @@ -1637,7 +1699,7 @@ - + AVAudioSession(KSY) Categories/AVAudioSession+KSY.html @@ -1677,7 +1739,7 @@ - + KSYMediaPlayback Protocols/KSYMediaPlayback.html @@ -1711,213 +1773,213 @@ - + KSYAVMuxerStatus Constants/KSYAVMuxerStatus.html - + KSYAudioCodec Constants/KSYAudioCodec.html - + KSYAudioEffectType Constants/KSYAudioEffectType.html - + KSYAudioNoiseSuppress Constants/KSYAudioNoiseSuppress.html - + KSYBWEstimateMode Constants/KSYBWEstimateMode.html - + KSYBgmPlayerState Constants/KSYBgmPlayerState.html - + KSYCaptureState Constants/KSYCaptureState.html - + KSYDevAuthStatus Constants/KSYDevAuthStatus.html - + KSYLiveScene Constants/KSYLiveScene.html - + KSYMPErrorCode Constants/KSYMPErrorCode.html - + KSYMicType Constants/KSYMicType.html - + KSYNetReachState Constants/KSYNetReachState.html - + KSYNetStateCode Constants/KSYNetStateCode.html - + KSYNetworkStatus Constants/KSYNetworkStatus.html - + KSYPlayRecordScheme Constants/KSYPlayRecordScheme.html - + KSYRecScene Constants/KSYRecScene.html - + KSYRecordError Constants/KSYRecordError.html - + KSYRecordState Constants/KSYRecordState.html - + KSYStreamErrorCode Constants/KSYStreamErrorCode.html - + KSYStreamState Constants/KSYStreamState.html - + KSYTranscodeErrorCode Constants/KSYTranscodeErrorCode.html - + KSYTranscodeState Constants/KSYTranscodeState.html - + KSYVideoCodec Constants/KSYVideoCodec.html - + KSYVideoDimension Constants/KSYVideoDimension.html - + KSYVideoEncodePerformance Constants/KSYVideoEncodePerformance.html - + KSY_NETTRACKER_ACTION Constants/KSY_NETTRACKER_ACTION.html - + MEDIAINFO_CODEC_ID Constants/MEDIAINFO_CODEC_ID.html - + MEDIAINFO_MUX_TYPE Constants/MEDIAINFO_MUX_TYPE.html - + MEDIAINFO_SAMPLE_FMT Constants/MEDIAINFO_SAMPLE_FMT.html - + MPMovieAudioPan Constants/MPMovieAudioPan.html - + MPMovieMetaType Constants/MPMovieMetaType.html - + MPMovieReloadMode Constants/MPMovieReloadMode.html - + MPMovieStatus Constants/MPMovieStatus.html - + MPMovieVideoDecoderMode Constants/MPMovieVideoDecoderMode.html - + MPMovieVideoDeinterlaceMode Constants/MPMovieVideoDeinterlaceMode.html - + KSYNetworkReachability Blocks/KSYNetworkReachability.html - + KSYNetworkReachable Blocks/KSYNetworkReachable.html - + KSYNetworkUnreachable Blocks/KSYNetworkUnreachable.html - + KSYPlyAudioDataBlock Blocks/KSYPlyAudioDataBlock.html - + KSYPlyMessageDataBlock Blocks/KSYPlyMessageDataBlock.html - + KSYPlyTextureBlock Blocks/KSYPlyTextureBlock.html - + KSYPlyVideoDataBlock Blocks/KSYPlyVideoDataBlock.html diff --git a/doc/docset/Contents/Resources/Tokens26.xml b/doc/docset/Contents/Resources/Tokens26.xml index ddc4d31..295d09e 100644 --- a/doc/docset/Contents/Resources/Tokens26.xml +++ b/doc/docset/Contents/Resources/Tokens26.xml @@ -205,6 +205,42 @@ + + //apple_ref/occ/instm/KSYGPUPicMixer/setClearCanvasBeforeDraw: + 刷新前是否清除画布 (默认 YES) + KSYGPUPicMixer.h + + @property (nonatomic, assign) BOOL clearCanvasBeforeDraw + + + //api/name/clearCanvasBeforeDraw + + + + + //apple_ref/occ/instm/KSYGPUPicMixer/clearCanvasBeforeDraw + 刷新前是否清除画布 (默认 YES) + KSYGPUPicMixer.h + + @property (nonatomic, assign) BOOL clearCanvasBeforeDraw + + + //api/name/clearCanvasBeforeDraw + + + + + //apple_ref/occ/instp/KSYGPUPicMixer/clearCanvasBeforeDraw + 刷新前是否清除画布 (默认 YES) + KSYGPUPicMixer.h + + @property (nonatomic, assign) BOOL clearCanvasBeforeDraw + + + //api/name/clearCanvasBeforeDraw + + + diff --git a/doc/docset/Contents/Resources/Tokens38.xml b/doc/docset/Contents/Resources/Tokens38.xml index ba947c2..6ba416a 100644 --- a/doc/docset/Contents/Resources/Tokens38.xml +++ b/doc/docset/Contents/Resources/Tokens38.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYNetRouterInfo - 网络链路上的路由节点信息类 - KSYNetTracker.h + //apple_ref/occ/cl/KSYMvEffect + KSYMvEffect MV特效类 + KSYMvEffect.h @@ -13,254 +13,31 @@ - //apple_ref/occ/instm/KSYNetRouterInfo/setIps: - 链路上每个节点的ip地址 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvEffect/initWithEffectShader: + 初始化并导入effectShader + KSYMvEffect.h - @property (nonatomic, readonly) NSMutableArray *ips + - (id)initWithEffectShader:(NSString *)effectShader + + + NSString + shader + + - - //api/name/ips - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/ips - 链路上每个节点的ip地址 - KSYNetTracker.h - - @property (nonatomic, readonly) NSMutableArray *ips - - - //api/name/ips - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/ips - 链路上每个节点的ip地址 - KSYNetTracker.h - - @property (nonatomic, readonly) NSMutableArray *ips - - - //api/name/ips - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setTmax: - 所有探测报文的rtt最大值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmax - - - //api/name/tmax - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/tmax - 所有探测报文的rtt最大值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmax - - - //api/name/tmax - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/tmax - 所有探测报文的rtt最大值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmax - - - //api/name/tmax - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setTmin: - 所有探测报文的rtt最小值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmin - - - //api/name/tmin - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/tmin - 所有探测报文的rtt最小值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmin - - - //api/name/tmin - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/tmin - 所有探测报文的rtt最小值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tmin - - - //api/name/tmin - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setTavg: - 所有探测报文的rtt平均值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tavg - - - //api/name/tavg - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/tavg - 所有探测报文的rtt平均值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tavg - - - //api/name/tavg - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/tavg - 所有探测报文的rtt平均值 - KSYNetTracker.h - - @property (nonatomic, readonly) float tavg - - - //api/name/tavg - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setTdev: - 所有探测报文的rtt均方差 - KSYNetTracker.h - - @property (nonatomic, readonly) float tdev - - - //api/name/tdev - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/tdev - 所有探测报文的rtt均方差 - KSYNetTracker.h - - @property (nonatomic, readonly) float tdev - - - //api/name/tdev - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/tdev - 所有探测报文的rtt均方差 - KSYNetTracker.h - - @property (nonatomic, readonly) float tdev - - - //api/name/tdev - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setLoss: - 所有探测报文的丢包率 - KSYNetTracker.h - - @property (nonatomic, readonly) float loss - - - //api/name/loss - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/loss - 所有探测报文的丢包率 - KSYNetTracker.h - - @property (nonatomic, readonly) float loss - - - //api/name/loss - - - - - //apple_ref/occ/instp/KSYNetRouterInfo/loss - 所有探测报文的丢包率 - KSYNetTracker.h - - @property (nonatomic, readonly) float loss - - - //api/name/loss - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/setNumber: - 统计所使用的探测报文个数 - KSYNetTracker.h - - @property (nonatomic, readonly) int number - - - //api/name/number - - - - - //apple_ref/occ/instm/KSYNetRouterInfo/number - 统计所使用的探测报文个数 - KSYNetTracker.h - - @property (nonatomic, readonly) int number - - - //api/name/number + //api/name/initWithEffectShader: - //apple_ref/occ/instp/KSYNetRouterInfo/number - 统计所使用的探测报文个数 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvEffect/closeMvEffect + 关闭mv effect + KSYMvEffect.h - @property (nonatomic, readonly) int number + - (void)closeMvEffect - //api/name/number + //api/name/closeMvEffect diff --git a/doc/docset/Contents/Resources/Tokens39.xml b/doc/docset/Contents/Resources/Tokens39.xml index 726e502..2e9ff71 100644 --- a/doc/docset/Contents/Resources/Tokens39.xml +++ b/doc/docset/Contents/Resources/Tokens39.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYNetTracker - 网络链路探测器类 - KSYNetTracker.h + //apple_ref/occ/cl/KSYMvFilter + KSYMvFilter MV效果类 + KSYMvFilter.h @@ -13,211 +13,106 @@ - //apple_ref/occ/instm/KSYNetTracker/start: - 开始探测 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvFilter/setMvScreenSource: + + KSYMvFilter.h - - (int)start:(NSString *__nonnull)domain - - - domain - 探测地址 - - - 成功开始返回0, 否则返回非0 - //api/name/start: - - - - - //apple_ref/occ/instm/KSYNetTracker/stop - 停止探测 - KSYNetTracker.h - - - (void)stop - - - //api/name/stop - - - - - //apple_ref/occ/instm/KSYNetTracker/setAction: - 探测方式 - KSYNetTracker.h - - @property (nonatomic, assign) KSY_NETTRACKER_ACTION action - - - //api/name/action - - - - - //apple_ref/occ/instm/KSYNetTracker/action - 探测方式 - KSYNetTracker.h - - @property (nonatomic, assign) KSY_NETTRACKER_ACTION action - - - //api/name/action - - - - - //apple_ref/occ/instp/KSYNetTracker/action - 探测方式 - KSYNetTracker.h - - @property (nonatomic, assign) KSY_NETTRACKER_ACTION action + @property (nonatomic, retain) GPUImageMovie *MvScreenSource - //api/name/action + //api/name/MvScreenSource - //apple_ref/occ/instm/KSYNetTracker/setTimeout: - 探测超时时间，单位是ms，默认值是1000ms - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvFilter/MvScreenSource + + KSYMvFilter.h - @property (nonatomic, assign) int timeout + @property (nonatomic, retain) GPUImageMovie *MvScreenSource - //api/name/timeout + //api/name/MvScreenSource - //apple_ref/occ/instm/KSYNetTracker/timeout - 探测超时时间，单位是ms，默认值是1000ms - KSYNetTracker.h + //apple_ref/occ/instp/KSYMvFilter/MvScreenSource + + KSYMvFilter.h - @property (nonatomic, assign) int timeout + @property (nonatomic, retain) GPUImageMovie *MvScreenSource - //api/name/timeout + //api/name/MvScreenSource - //apple_ref/occ/instp/KSYNetTracker/timeout - 探测超时时间，单位是ms，默认值是1000ms - KSYNetTracker.h - - @property (nonatomic, assign) int timeout - + //apple_ref/occ/instm/KSYMvFilter/initWithPath:shouldRepeat: + 单个mp4 filter + KSYMvFilter.h - //api/name/timeout - - - - - //apple_ref/occ/instm/KSYNetTracker/setMaxttl: - 探测使用的最大ttl值，默认值是64 - KSYNetTracker.h - - @property (nonatomic, assign) int maxttl - - - //api/name/maxttl - - - - - //apple_ref/occ/instm/KSYNetTracker/maxttl - 探测使用的最大ttl值，默认值是64 - KSYNetTracker.h - - @property (nonatomic, assign) int maxttl - - - //api/name/maxttl - - - - - //apple_ref/occ/instp/KSYNetTracker/maxttl - 探测使用的最大ttl值，默认值是64 - KSYNetTracker.h - - @property (nonatomic, assign) int maxttl - - - //api/name/maxttl - - - - - //apple_ref/occ/instm/KSYNetTracker/setNumber: - 探测次数，默认值是10 - KSYNetTracker.h - - @property (nonatomic, assign) int number - - - //api/name/number - - - - - //apple_ref/occ/instm/KSYNetTracker/number - 探测次数，默认值是10 - KSYNetTracker.h - - @property (nonatomic, assign) int number - - - //api/name/number + - (id)initWithPath:(NSURL *)mp4URL shouldRepeat:(BOOL)bRepeat + + + mp4URL + 指定mp4路径 + + shouldRepeat + mp4是否循环播放 + + + mp4 filter + //api/name/initWithPath:shouldRepeat: - //apple_ref/occ/instp/KSYNetTracker/number - 探测次数，默认值是10 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvFilter/closeMvFilter + 关闭mv filter + KSYMvFilter.h - @property (nonatomic, assign) int number + - (void)closeMvFilter - //api/name/number + //api/name/closeMvFilter - //apple_ref/occ/instm/KSYNetTracker/setRouterInfo: - 链路状况 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvFilter/setMvPlayEndCallback: + mv播放结束回调函数 + KSYMvFilter.h - @property (nonatomic, readonly) NSMutableArray *routerInfo + @property (nonatomic, copy) void ( ^ ) ( ) mvPlayEndCallback - //api/name/routerInfo + //api/name/mvPlayEndCallback - //apple_ref/occ/instm/KSYNetTracker/routerInfo - 链路状况 - KSYNetTracker.h + //apple_ref/occ/instm/KSYMvFilter/mvPlayEndCallback + mv播放结束回调函数 + KSYMvFilter.h - @property (nonatomic, readonly) NSMutableArray *routerInfo + @property (nonatomic, copy) void ( ^ ) ( ) mvPlayEndCallback - //api/name/routerInfo + //api/name/mvPlayEndCallback - //apple_ref/occ/instp/KSYNetTracker/routerInfo - 链路状况 - KSYNetTracker.h + //apple_ref/occ/instp/KSYMvFilter/mvPlayEndCallback + mv播放结束回调函数 + KSYMvFilter.h - @property (nonatomic, readonly) NSMutableArray *routerInfo + @property (nonatomic, copy) void ( ^ ) ( ) mvPlayEndCallback - //api/name/routerInfo + //api/name/mvPlayEndCallback diff --git a/doc/docset/Contents/Resources/Tokens40.xml b/doc/docset/Contents/Resources/Tokens40.xml index 48fdaa1..d0423ee 100644 --- a/doc/docset/Contents/Resources/Tokens40.xml +++ b/doc/docset/Contents/Resources/Tokens40.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYQosInfo - Qos信息 - KSYQosInfo.h + //apple_ref/occ/cl/KSYNetRouterInfo + 网络链路上的路由节点信息类 + KSYNetTracker.h @@ -13,326 +13,254 @@ - //apple_ref/occ/instm/KSYQosInfo/setAudioBufferByteLength: - audio queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setIps: + 链路上每个节点的ip地址 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferByteLength + @property (nonatomic, readonly) NSMutableArray *ips - //api/name/audioBufferByteLength + //api/name/ips - //apple_ref/occ/instm/KSYQosInfo/audioBufferByteLength - audio queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/ips + 链路上每个节点的ip地址 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferByteLength + @property (nonatomic, readonly) NSMutableArray *ips - //api/name/audioBufferByteLength + //api/name/ips - //apple_ref/occ/instp/KSYQosInfo/audioBufferByteLength - audio queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/ips + 链路上每个节点的ip地址 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferByteLength + @property (nonatomic, readonly) NSMutableArray *ips - //api/name/audioBufferByteLength + //api/name/ips - //apple_ref/occ/instm/KSYQosInfo/setAudioBufferTimeLength: - audio queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setTmax: + 所有探测报文的rtt最大值 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferTimeLength + @property (nonatomic, readonly) float tmax - //api/name/audioBufferTimeLength + //api/name/tmax - //apple_ref/occ/instm/KSYQosInfo/audioBufferTimeLength - audio queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/tmax + 所有探测报文的rtt最大值 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferTimeLength + @property (nonatomic, readonly) float tmax - //api/name/audioBufferTimeLength + //api/name/tmax - //apple_ref/occ/instp/KSYQosInfo/audioBufferTimeLength - audio queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/tmax + 所有探测报文的rtt最大值 + KSYNetTracker.h - @property (nonatomic, assign) int audioBufferTimeLength + @property (nonatomic, readonly) float tmax - //api/name/audioBufferTimeLength + //api/name/tmax - //apple_ref/occ/instm/KSYQosInfo/setAudioTotalDataSize: - size of data have arrived at audio queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setTmin: + 所有探测报文的rtt最小值 + KSYNetTracker.h - @property (nonatomic, assign) int64_t audioTotalDataSize + @property (nonatomic, readonly) float tmin - //api/name/audioTotalDataSize + //api/name/tmin - //apple_ref/occ/instm/KSYQosInfo/audioTotalDataSize - size of data have arrived at audio queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/tmin + 所有探测报文的rtt最小值 + KSYNetTracker.h - @property (nonatomic, assign) int64_t audioTotalDataSize + @property (nonatomic, readonly) float tmin - //api/name/audioTotalDataSize + //api/name/tmin - //apple_ref/occ/instp/KSYQosInfo/audioTotalDataSize - size of data have arrived at audio queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/tmin + 所有探测报文的rtt最小值 + KSYNetTracker.h - @property (nonatomic, assign) int64_t audioTotalDataSize + @property (nonatomic, readonly) float tmin - //api/name/audioTotalDataSize + //api/name/tmin - //apple_ref/occ/instm/KSYQosInfo/setVideoBufferByteLength: - video queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setTavg: + 所有探测报文的rtt平均值 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferByteLength + @property (nonatomic, readonly) float tavg - //api/name/videoBufferByteLength + //api/name/tavg - //apple_ref/occ/instm/KSYQosInfo/videoBufferByteLength - video queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/tavg + 所有探测报文的rtt平均值 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferByteLength + @property (nonatomic, readonly) float tavg - //api/name/videoBufferByteLength + //api/name/tavg - //apple_ref/occ/instp/KSYQosInfo/videoBufferByteLength - video queue size in bytes - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/tavg + 所有探测报文的rtt平均值 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferByteLength + @property (nonatomic, readonly) float tavg - //api/name/videoBufferByteLength + //api/name/tavg - //apple_ref/occ/instm/KSYQosInfo/setVideoBufferTimeLength: - video queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setTdev: + 所有探测报文的rtt均方差 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferTimeLength + @property (nonatomic, readonly) float tdev - //api/name/videoBufferTimeLength + //api/name/tdev - //apple_ref/occ/instm/KSYQosInfo/videoBufferTimeLength - video queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/tdev + 所有探测报文的rtt均方差 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferTimeLength + @property (nonatomic, readonly) float tdev - //api/name/videoBufferTimeLength + //api/name/tdev - //apple_ref/occ/instp/KSYQosInfo/videoBufferTimeLength - video queue time length in ms - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/tdev + 所有探测报文的rtt均方差 + KSYNetTracker.h - @property (nonatomic, assign) int videoBufferTimeLength + @property (nonatomic, readonly) float tdev - //api/name/videoBufferTimeLength + //api/name/tdev - //apple_ref/occ/instm/KSYQosInfo/setVideoTotalDataSize: - size of data have arrived at video queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setLoss: + 所有探测报文的丢包率 + KSYNetTracker.h - @property (nonatomic, assign) int64_t videoTotalDataSize + @property (nonatomic, readonly) float loss - //api/name/videoTotalDataSize + //api/name/loss - //apple_ref/occ/instm/KSYQosInfo/videoTotalDataSize - size of data have arrived at video queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/loss + 所有探测报文的丢包率 + KSYNetTracker.h - @property (nonatomic, assign) int64_t videoTotalDataSize + @property (nonatomic, readonly) float loss - //api/name/videoTotalDataSize + //api/name/loss - //apple_ref/occ/instp/KSYQosInfo/videoTotalDataSize - size of data have arrived at video queue since playing. unit:byte - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/loss + 所有探测报文的丢包率 + KSYNetTracker.h - @property (nonatomic, assign) int64_t videoTotalDataSize + @property (nonatomic, readonly) float loss - //api/name/videoTotalDataSize + //api/name/loss - //apple_ref/occ/instm/KSYQosInfo/setTotalDataSize: - size of total audio and video data since playing. unit: byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/setNumber: + 统计所使用的探测报文个数 + KSYNetTracker.h - @property (nonatomic, assign) int64_t totalDataSize + @property (nonatomic, readonly) int number - //api/name/totalDataSize + //api/name/number - //apple_ref/occ/instm/KSYQosInfo/totalDataSize - size of total audio and video data since playing. unit: byte - KSYQosInfo.h + //apple_ref/occ/instm/KSYNetRouterInfo/number + 统计所使用的探测报文个数 + KSYNetTracker.h - @property (nonatomic, assign) int64_t totalDataSize + @property (nonatomic, readonly) int number - //api/name/totalDataSize + //api/name/number - //apple_ref/occ/instp/KSYQosInfo/totalDataSize - size of total audio and video data since playing. unit: byte - KSYQosInfo.h + //apple_ref/occ/instp/KSYNetRouterInfo/number + 统计所使用的探测报文个数 + KSYNetTracker.h - @property (nonatomic, assign) int64_t totalDataSize + @property (nonatomic, readonly) int number - //api/name/totalDataSize - - - - - //apple_ref/occ/instm/KSYQosInfo/setVideoDecodeFPS: - video decode frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoDecodeFPS - - - //api/name/videoDecodeFPS - - - - - //apple_ref/occ/instm/KSYQosInfo/videoDecodeFPS - video decode frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoDecodeFPS - - - //api/name/videoDecodeFPS - - - - - //apple_ref/occ/instp/KSYQosInfo/videoDecodeFPS - video decode frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoDecodeFPS - - - //api/name/videoDecodeFPS - - - - - //apple_ref/occ/instm/KSYQosInfo/setVideoRefreshFPS: - video refresh frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoRefreshFPS - - - //api/name/videoRefreshFPS - - - - - //apple_ref/occ/instm/KSYQosInfo/videoRefreshFPS - video refresh frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoRefreshFPS - - - //api/name/videoRefreshFPS - - - - - //apple_ref/occ/instp/KSYQosInfo/videoRefreshFPS - video refresh frame count per second - KSYQosInfo.h - - @property (nonatomic, assign) float videoRefreshFPS - - - //api/name/videoRefreshFPS + //api/name/number diff --git a/doc/docset/Contents/Resources/Tokens41.xml b/doc/docset/Contents/Resources/Tokens41.xml index 77b4712..7b34dda 100644 --- a/doc/docset/Contents/Resources/Tokens41.xml +++ b/doc/docset/Contents/Resources/Tokens41.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYReachability - - KSYReachability.h + //apple_ref/occ/cl/KSYNetTracker + 网络链路探测器类 + KSYNetTracker.h @@ -13,374 +13,211 @@ - //apple_ref/occ/instm/KSYReachability/setReachableBlock: - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/start: + 开始探测 + KSYNetTracker.h - @property (nonatomic, copy) KSYNetworkReachable reachableBlock - - - //api/name/reachableBlock - - - - - //apple_ref/occ/instm/KSYReachability/reachableBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkReachable reachableBlock - - - //api/name/reachableBlock - - - - - //apple_ref/occ/instp/KSYReachability/reachableBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkReachable reachableBlock - - - //api/name/reachableBlock - - - - - //apple_ref/occ/instm/KSYReachability/setUnreachableBlock: - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - - - //api/name/unreachableBlock - - - - - //apple_ref/occ/instm/KSYReachability/unreachableBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - - - //api/name/unreachableBlock - - - - - //apple_ref/occ/instp/KSYReachability/unreachableBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - - - //api/name/unreachableBlock - - - - - //apple_ref/occ/instm/KSYReachability/setReachabilityBlock: - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - - - //api/name/reachabilityBlock - - - - - //apple_ref/occ/instm/KSYReachability/reachabilityBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - - - //api/name/reachabilityBlock - - - - - //apple_ref/occ/instp/KSYReachability/reachabilityBlock - - KSYReachability.h - - @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - - - //api/name/reachabilityBlock - - - - - //apple_ref/occ/instm/KSYReachability/setReachableOnWWAN: - - KSYReachability.h - - @property (nonatomic, assign) BOOL reachableOnWWAN - - - //api/name/reachableOnWWAN - - - - - //apple_ref/occ/instm/KSYReachability/reachableOnWWAN - - KSYReachability.h - - @property (nonatomic, assign) BOOL reachableOnWWAN - - - //api/name/reachableOnWWAN - - - - - //apple_ref/occ/instp/KSYReachability/reachableOnWWAN - - KSYReachability.h - - @property (nonatomic, assign) BOOL reachableOnWWAN - - - //api/name/reachableOnWWAN - - - - - //apple_ref/occ/clm/KSYReachability/reachabilityWithHostname: - - KSYReachability.h - - + (instancetype)reachabilityWithHostname:(NSString *)hostname - - - //api/name/reachabilityWithHostname: - - - - - //apple_ref/occ/clm/KSYReachability/reachabilityWithHostName: - - KSYReachability.h - - + (instancetype)reachabilityWithHostName:(NSString *)hostname - - - //api/name/reachabilityWithHostName: - - - - - //apple_ref/occ/clm/KSYReachability/reachabilityForInternetConnection - - KSYReachability.h - - + (instancetype)reachabilityForInternetConnection - - - //api/name/reachabilityForInternetConnection + - (int)start:(NSString *__nonnull)domain + + + domain + 探测地址 + + + 成功开始返回0, 否则返回非0 + //api/name/start: - //apple_ref/occ/clm/KSYReachability/reachabilityWithAddress: - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/stop + 停止探测 + KSYNetTracker.h - + (instancetype)reachabilityWithAddress:(void *)hostAddress + - (void)stop - //api/name/reachabilityWithAddress: + //api/name/stop - //apple_ref/occ/clm/KSYReachability/reachabilityForLocalWiFi - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/setAction: + 探测方式 + KSYNetTracker.h - + (instancetype)reachabilityForLocalWiFi + @property (nonatomic, assign) KSY_NETTRACKER_ACTION action - //api/name/reachabilityForLocalWiFi + //api/name/action - //apple_ref/occ/instm/KSYReachability/initWithReachabilityRef: - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/action + 探测方式 + KSYNetTracker.h - - (instancetype)initWithReachabilityRef:(SCNetworkReachabilityRef)ref + @property (nonatomic, assign) KSY_NETTRACKER_ACTION action - //api/name/initWithReachabilityRef: + //api/name/action - //apple_ref/occ/instm/KSYReachability/startNotifier - - KSYReachability.h + //apple_ref/occ/instp/KSYNetTracker/action + 探测方式 + KSYNetTracker.h - - (BOOL)startNotifier + @property (nonatomic, assign) KSY_NETTRACKER_ACTION action - //api/name/startNotifier + //api/name/action - //apple_ref/occ/instm/KSYReachability/stopNotifier - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/setTimeout: + 探测超时时间，单位是ms，默认值是1000ms + KSYNetTracker.h - - (void)stopNotifier + @property (nonatomic, assign) int timeout - //api/name/stopNotifier + //api/name/timeout - //apple_ref/occ/instm/KSYReachability/isReachable - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/timeout + 探测超时时间，单位是ms，默认值是1000ms + KSYNetTracker.h - - (BOOL)isReachable + @property (nonatomic, assign) int timeout - //api/name/isReachable + //api/name/timeout - //apple_ref/occ/instm/KSYReachability/isReachableViaWWAN - - KSYReachability.h + //apple_ref/occ/instp/KSYNetTracker/timeout + 探测超时时间，单位是ms，默认值是1000ms + KSYNetTracker.h - - (BOOL)isReachableViaWWAN + @property (nonatomic, assign) int timeout - //api/name/isReachableViaWWAN + //api/name/timeout - //apple_ref/occ/instm/KSYReachability/isReachableViaWiFi - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/setMaxttl: + 探测使用的最大ttl值，默认值是64 + KSYNetTracker.h - - (BOOL)isReachableViaWiFi + @property (nonatomic, assign) int maxttl - //api/name/isReachableViaWiFi + //api/name/maxttl - //apple_ref/occ/instm/KSYReachability/isConnectionRequired - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/maxttl + 探测使用的最大ttl值，默认值是64 + KSYNetTracker.h - - (BOOL)isConnectionRequired + @property (nonatomic, assign) int maxttl - //api/name/isConnectionRequired + //api/name/maxttl - //apple_ref/occ/instm/KSYReachability/connectionRequired - - KSYReachability.h + //apple_ref/occ/instp/KSYNetTracker/maxttl + 探测使用的最大ttl值，默认值是64 + KSYNetTracker.h - - (BOOL)connectionRequired + @property (nonatomic, assign) int maxttl - //api/name/connectionRequired + //api/name/maxttl - //apple_ref/occ/instm/KSYReachability/isConnectionOnDemand - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/setNumber: + 探测次数，默认值是10 + KSYNetTracker.h - - (BOOL)isConnectionOnDemand + @property (nonatomic, assign) int number - //api/name/isConnectionOnDemand + //api/name/number - //apple_ref/occ/instm/KSYReachability/isInterventionRequired - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/number + 探测次数，默认值是10 + KSYNetTracker.h - - (BOOL)isInterventionRequired + @property (nonatomic, assign) int number - //api/name/isInterventionRequired + //api/name/number - //apple_ref/occ/instm/KSYReachability/currentReachabilityStatus - - KSYReachability.h + //apple_ref/occ/instp/KSYNetTracker/number + 探测次数，默认值是10 + KSYNetTracker.h - - (KSYNetworkStatus)currentReachabilityStatus + @property (nonatomic, assign) int number - //api/name/currentReachabilityStatus + //api/name/number - //apple_ref/occ/instm/KSYReachability/reachabilityFlags - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/setRouterInfo: + 链路状况 + KSYNetTracker.h - - (SCNetworkReachabilityFlags)reachabilityFlags + @property (nonatomic, readonly) NSMutableArray *routerInfo - //api/name/reachabilityFlags + //api/name/routerInfo - //apple_ref/occ/instm/KSYReachability/currentReachabilityString - - KSYReachability.h + //apple_ref/occ/instm/KSYNetTracker/routerInfo + 链路状况 + KSYNetTracker.h - - (NSString *)currentReachabilityString + @property (nonatomic, readonly) NSMutableArray *routerInfo - //api/name/currentReachabilityString + //api/name/routerInfo - //apple_ref/occ/instm/KSYReachability/currentReachabilityFlags - - KSYReachability.h + //apple_ref/occ/instp/KSYNetTracker/routerInfo + 链路状况 + KSYNetTracker.h - - (NSString *)currentReachabilityFlags + @property (nonatomic, readonly) NSMutableArray *routerInfo - //api/name/currentReachabilityFlags + //api/name/routerInfo diff --git a/doc/docset/Contents/Resources/Tokens42.xml b/doc/docset/Contents/Resources/Tokens42.xml index 55bb397..5d5f42a 100644 --- a/doc/docset/Contents/Resources/Tokens42.xml +++ b/doc/docset/Contents/Resources/Tokens42.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYSpecialEffects - 金山云特效滤镜 - KSYSpecialEffects.h + //apple_ref/occ/cl/KSYQosInfo + Qos信息 + KSYQosInfo.h @@ -13,84 +13,326 @@ - //apple_ref/occ/clm/KSYSpecialEffects/showVersion - show version of this filter - KSYSpecialEffects.h + //apple_ref/occ/instm/KSYQosInfo/setAudioBufferByteLength: + audio queue size in bytes + KSYQosInfo.h - + (void)showVersion + @property (nonatomic, assign) int audioBufferByteLength - //api/name/showVersion + //api/name/audioBufferByteLength - //apple_ref/occ/instm/KSYSpecialEffects/initWithUIImage: - 初始化并指定特效素材 - KSYSpecialEffects.h + //apple_ref/occ/instm/KSYQosInfo/audioBufferByteLength + audio queue size in bytes + KSYQosInfo.h - - (id)initWithUIImage:(UIImage *)image - - - image - 特效素材 - - - 构造的滤镜 - //api/name/initWithUIImage: + @property (nonatomic, assign) int audioBufferByteLength + + + //api/name/audioBufferByteLength + + + + + //apple_ref/occ/instp/KSYQosInfo/audioBufferByteLength + audio queue size in bytes + KSYQosInfo.h + + @property (nonatomic, assign) int audioBufferByteLength + + + //api/name/audioBufferByteLength + + + + + //apple_ref/occ/instm/KSYQosInfo/setAudioBufferTimeLength: + audio queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int audioBufferTimeLength + + + //api/name/audioBufferTimeLength + + + + + //apple_ref/occ/instm/KSYQosInfo/audioBufferTimeLength + audio queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int audioBufferTimeLength + + + //api/name/audioBufferTimeLength + + + + + //apple_ref/occ/instp/KSYQosInfo/audioBufferTimeLength + audio queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int audioBufferTimeLength + + + //api/name/audioBufferTimeLength + + + + + //apple_ref/occ/instm/KSYQosInfo/setAudioTotalDataSize: + size of data have arrived at audio queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t audioTotalDataSize + + + //api/name/audioTotalDataSize + + + + + //apple_ref/occ/instm/KSYQosInfo/audioTotalDataSize + size of data have arrived at audio queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t audioTotalDataSize + + + //api/name/audioTotalDataSize + + + + + //apple_ref/occ/instp/KSYQosInfo/audioTotalDataSize + size of data have arrived at audio queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t audioTotalDataSize + + + //api/name/audioTotalDataSize + + + + + //apple_ref/occ/instm/KSYQosInfo/setVideoBufferByteLength: + video queue size in bytes + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferByteLength + + + //api/name/videoBufferByteLength + + + + + //apple_ref/occ/instm/KSYQosInfo/videoBufferByteLength + video queue size in bytes + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferByteLength + + + //api/name/videoBufferByteLength + + + + + //apple_ref/occ/instp/KSYQosInfo/videoBufferByteLength + video queue size in bytes + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferByteLength + + + //api/name/videoBufferByteLength + + + + + //apple_ref/occ/instm/KSYQosInfo/setVideoBufferTimeLength: + video queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferTimeLength + + + //api/name/videoBufferTimeLength + + + + + //apple_ref/occ/instm/KSYQosInfo/videoBufferTimeLength + video queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferTimeLength + + + //api/name/videoBufferTimeLength + + + + + //apple_ref/occ/instp/KSYQosInfo/videoBufferTimeLength + video queue time length in ms + KSYQosInfo.h + + @property (nonatomic, assign) int videoBufferTimeLength + + + //api/name/videoBufferTimeLength + + + + + //apple_ref/occ/instm/KSYQosInfo/setVideoTotalDataSize: + size of data have arrived at video queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t videoTotalDataSize + + + //api/name/videoTotalDataSize - //apple_ref/occ/instm/KSYSpecialEffects/setSpecialEffectsUIImage: - 指定特效素材 - KSYSpecialEffects.h + //apple_ref/occ/instm/KSYQosInfo/videoTotalDataSize + size of data have arrived at video queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t videoTotalDataSize + + + //api/name/videoTotalDataSize + + + + + //apple_ref/occ/instp/KSYQosInfo/videoTotalDataSize + size of data have arrived at video queue since playing. unit:byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t videoTotalDataSize + + + //api/name/videoTotalDataSize + + + + + //apple_ref/occ/instm/KSYQosInfo/setTotalDataSize: + size of total audio and video data since playing. unit: byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t totalDataSize + + + //api/name/totalDataSize + + + + + //apple_ref/occ/instm/KSYQosInfo/totalDataSize + size of total audio and video data since playing. unit: byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t totalDataSize + + + //api/name/totalDataSize + + + + + //apple_ref/occ/instp/KSYQosInfo/totalDataSize + size of total audio and video data since playing. unit: byte + KSYQosInfo.h + + @property (nonatomic, assign) int64_t totalDataSize + + + //api/name/totalDataSize + + + + + //apple_ref/occ/instm/KSYQosInfo/setVideoDecodeFPS: + video decode frame count per second + KSYQosInfo.h + + @property (nonatomic, assign) float videoDecodeFPS + + + //api/name/videoDecodeFPS + + + + + //apple_ref/occ/instm/KSYQosInfo/videoDecodeFPS + video decode frame count per second + KSYQosInfo.h + + @property (nonatomic, assign) float videoDecodeFPS + + + //api/name/videoDecodeFPS + + + + + //apple_ref/occ/instp/KSYQosInfo/videoDecodeFPS + video decode frame count per second + KSYQosInfo.h + + @property (nonatomic, assign) float videoDecodeFPS - - (void)setSpecialEffectsUIImage:(UIImage *)image - - - image - 特效素材 - - - //api/name/setSpecialEffectsUIImage: + //api/name/videoDecodeFPS - //apple_ref/occ/instm/KSYSpecialEffects/setIntensity: - 特效参数 - KSYSpecialEffects.h + //apple_ref/occ/instm/KSYQosInfo/setVideoRefreshFPS: + video refresh frame count per second + KSYQosInfo.h - @property (readwrite, nonatomic) CGFloat intensity + @property (nonatomic, assign) float videoRefreshFPS - //api/name/intensity + //api/name/videoRefreshFPS - //apple_ref/occ/instm/KSYSpecialEffects/intensity - 特效参数 - KSYSpecialEffects.h + //apple_ref/occ/instm/KSYQosInfo/videoRefreshFPS + video refresh frame count per second + KSYQosInfo.h - @property (readwrite, nonatomic) CGFloat intensity + @property (nonatomic, assign) float videoRefreshFPS - //api/name/intensity + //api/name/videoRefreshFPS - //apple_ref/occ/instp/KSYSpecialEffects/intensity - 特效参数 - KSYSpecialEffects.h + //apple_ref/occ/instp/KSYQosInfo/videoRefreshFPS + video refresh frame count per second + KSYQosInfo.h - @property (readwrite, nonatomic) CGFloat intensity + @property (nonatomic, assign) float videoRefreshFPS - //api/name/intensity + //api/name/videoRefreshFPS diff --git a/doc/docset/Contents/Resources/Tokens43.xml b/doc/docset/Contents/Resources/Tokens43.xml index c75ab85..cbc1964 100644 --- a/doc/docset/Contents/Resources/Tokens43.xml +++ b/doc/docset/Contents/Resources/Tokens43.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYStreamerBase - 金山云直播推流SDK iOS版提供了iOS移动设备上的推流功能 - KSYStreamerBase.h + //apple_ref/occ/cl/KSYReachability + + KSYReachability.h @@ -13,2365 +13,374 @@ - //apple_ref/occ/instm/KSYStreamerBase/getKSYVersion - 获取SDK版本号 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/setReachableBlock: + + KSYReachability.h - - (NSString *)getKSYVersion + @property (nonatomic, copy) KSYNetworkReachable reachableBlock - //api/name/getKSYVersion + //api/name/reachableBlock - //apple_ref/occ/instm/KSYStreamerBase/setHostURL: - 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/reachableBlock + + KSYReachability.h - @property (nonatomic, readonly) NSURL *hostURL + @property (nonatomic, copy) KSYNetworkReachable reachableBlock - //api/name/hostURL + //api/name/reachableBlock - //apple_ref/occ/instm/KSYStreamerBase/hostURL - 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 - KSYStreamerBase.h + //apple_ref/occ/instp/KSYReachability/reachableBlock + + KSYReachability.h - @property (nonatomic, readonly) NSURL *hostURL + @property (nonatomic, copy) KSYNetworkReachable reachableBlock - //api/name/hostURL + //api/name/reachableBlock - //apple_ref/occ/instp/KSYStreamerBase/hostURL - 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/setUnreachableBlock: + + KSYReachability.h - @property (nonatomic, readonly) NSURL *hostURL + @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - //api/name/hostURL + //api/name/unreachableBlock - //apple_ref/occ/instm/KSYStreamerBase/setVideoFPS: - 视频帧率 默认:15 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/unreachableBlock + + KSYReachability.h - @property (nonatomic, assign) int videoFPS + @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - //api/name/videoFPS + //api/name/unreachableBlock - //apple_ref/occ/instm/KSYStreamerBase/videoFPS - 视频帧率 默认:15 - KSYStreamerBase.h + //apple_ref/occ/instp/KSYReachability/unreachableBlock + + KSYReachability.h - @property (nonatomic, assign) int videoFPS + @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock - //api/name/videoFPS + //api/name/unreachableBlock - //apple_ref/occ/instp/KSYStreamerBase/videoFPS - 视频帧率 默认:15 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/setReachabilityBlock: + + KSYReachability.h - @property (nonatomic, assign) int videoFPS + @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - //api/name/videoFPS + //api/name/reachabilityBlock - //apple_ref/occ/instm/KSYStreamerBase/setVideoMinFPS: - 视频帧率最小值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/reachabilityBlock + + KSYReachability.h - @property (nonatomic, assign) int videoMinFPS + @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - //api/name/videoMinFPS + //api/name/reachabilityBlock - //apple_ref/occ/instm/KSYStreamerBase/videoMinFPS - 视频帧率最小值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/instp/KSYReachability/reachabilityBlock + + KSYReachability.h - @property (nonatomic, assign) int videoMinFPS + @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock - //api/name/videoMinFPS + //api/name/reachabilityBlock - //apple_ref/occ/instp/KSYStreamerBase/videoMinFPS - 视频帧率最小值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/setReachableOnWWAN: + + KSYReachability.h - @property (nonatomic, assign) int videoMinFPS + @property (nonatomic, assign) BOOL reachableOnWWAN - //api/name/videoMinFPS + //api/name/reachableOnWWAN - //apple_ref/occ/instm/KSYStreamerBase/setVideoMaxFPS: - 视频帧率最大值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/reachableOnWWAN + + KSYReachability.h - @property (nonatomic, assign) int videoMaxFPS + @property (nonatomic, assign) BOOL reachableOnWWAN - //api/name/videoMaxFPS + //api/name/reachableOnWWAN - //apple_ref/occ/instm/KSYStreamerBase/videoMaxFPS - 视频帧率最大值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/instp/KSYReachability/reachableOnWWAN + + KSYReachability.h - @property (nonatomic, assign) int videoMaxFPS + @property (nonatomic, assign) BOOL reachableOnWWAN - //api/name/videoMaxFPS + //api/name/reachableOnWWAN - //apple_ref/occ/instp/KSYStreamerBase/videoMaxFPS - 视频帧率最大值，默认与videoFPS相同 - KSYStreamerBase.h + //apple_ref/occ/clm/KSYReachability/reachabilityWithHostname: + + KSYReachability.h - @property (nonatomic, assign) int videoMaxFPS + + (instancetype)reachabilityWithHostname:(NSString *)hostname - //api/name/videoMaxFPS + //api/name/reachabilityWithHostname: - //apple_ref/occ/instm/KSYStreamerBase/setVideoCodec: - 视频编码器 默认为 自动选择 - KSYStreamerBase.h + //apple_ref/occ/clm/KSYReachability/reachabilityWithHostName: + + KSYReachability.h - - //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf - - - - @property (nonatomic, assign) KSYVideoCodec videoCodec - - - //api/name/videoCodec - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoCodec - 视频编码器 默认为 自动选择 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf - - - - @property (nonatomic, assign) KSYVideoCodec videoCodec - - - //api/name/videoCodec - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoCodec - 视频编码器 默认为 自动选择 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf - - - - @property (nonatomic, assign) KSYVideoCodec videoCodec - - - //api/name/videoCodec - - - - - //apple_ref/occ/instm/KSYStreamerBase/setAudioCodec: - 音频编码器 (默认为AAC-HE) - KSYStreamerBase.h - - - //apple_ref/c/tdef/KSYAudioCodec - - - - @property (nonatomic, assign) KSYAudioCodec audioCodec - - - //api/name/audioCodec - - - - - //apple_ref/occ/instm/KSYStreamerBase/audioCodec - 音频编码器 (默认为AAC-HE) - KSYStreamerBase.h - - - //apple_ref/c/tdef/KSYAudioCodec - - - - @property (nonatomic, assign) KSYAudioCodec audioCodec - - - //api/name/audioCodec - - - - - //apple_ref/occ/instp/KSYStreamerBase/audioCodec - 音频编码器 (默认为AAC-HE) - KSYStreamerBase.h - - - //apple_ref/c/tdef/KSYAudioCodec - - - - @property (nonatomic, assign) KSYAudioCodec audioCodec - - - //api/name/audioCodec - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoInitBitrate: - 视频编码起始码率（单位:kbps, 默认:500） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoInitBitrate - - - //api/name/videoInitBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoInitBitrate - 视频编码起始码率（单位:kbps, 默认:500） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoInitBitrate - - - //api/name/videoInitBitrate - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoInitBitrate - 视频编码起始码率（单位:kbps, 默认:500） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoInitBitrate - - - //api/name/videoInitBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoMaxBitrate: - 视频编码最高码率（单位:kbps, 默认:800） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoMaxBitrate - - - //api/name/videoMaxBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoMaxBitrate - 视频编码最高码率（单位:kbps, 默认:800） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoMaxBitrate - - - //api/name/videoMaxBitrate - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - 视频编码最高码率（单位:kbps, 默认:800） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - - - - @property (nonatomic, assign) int videoMaxBitrate - - - //api/name/videoMaxBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoMinBitrate: - 视频编码最低码率（单位:kbps, 默认:200） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, assign) int videoMinBitrate - - - //api/name/videoMinBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoMinBitrate - 视频编码最低码率（单位:kbps, 默认:200） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, assign) int videoMinBitrate - - - //api/name/videoMinBitrate - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate - 视频编码最低码率（单位:kbps, 默认:200） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, assign) int videoMinBitrate - - - //api/name/videoMinBitrate - - - - - //apple_ref/occ/instm/KSYStreamerBase/setStreamMetaData: - 推流全局附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *streamMetaData - - - //api/name/streamMetaData - - - - - //apple_ref/occ/instm/KSYStreamerBase/streamMetaData - 推流全局附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *streamMetaData - - - //api/name/streamMetaData - - - - - //apple_ref/occ/instp/KSYStreamerBase/streamMetaData - 推流全局附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *streamMetaData - - - //api/name/streamMetaData - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoMetaData: - 视频流附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *videoMetaData - - - //api/name/videoMetaData - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoMetaData - 视频流附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *videoMetaData - - - //api/name/videoMetaData - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoMetaData - 视频流附带的metadata (默认为nil) - KSYStreamerBase.h - - @property (atomic, copy) NSDictionary *videoMetaData - - - //api/name/videoMetaData - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoCrf: - 质量等级（默认:20） - KSYStreamerBase.h - - @property (nonatomic, assign) int videoCrf - - - //api/name/videoCrf - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoCrf - 质量等级（默认:20） - KSYStreamerBase.h - - @property (nonatomic, assign) int videoCrf - - - //api/name/videoCrf - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoCrf - 质量等级（默认:20） - KSYStreamerBase.h - - @property (nonatomic, assign) int videoCrf - - - //api/name/videoCrf - - - - - //apple_ref/occ/instm/KSYStreamerBase/setMaxKeyInterval: - 最大关键帧间隔（单位:秒, 默认:3） - KSYStreamerBase.h - - @property (nonatomic, assign) float maxKeyInterval - - - //api/name/maxKeyInterval - - - - - //apple_ref/occ/instm/KSYStreamerBase/maxKeyInterval - 最大关键帧间隔（单位:秒, 默认:3） - KSYStreamerBase.h - - @property (nonatomic, assign) float maxKeyInterval - - - //api/name/maxKeyInterval - - - - - //apple_ref/occ/instp/KSYStreamerBase/maxKeyInterval - 最大关键帧间隔（单位:秒, 默认:3） - KSYStreamerBase.h - - @property (nonatomic, assign) float maxKeyInterval - - - //api/name/maxKeyInterval - - - - - //apple_ref/occ/instm/KSYStreamerBase/setAudiokBPS: - 音频编码码率（单位:kbps） - KSYStreamerBase.h - - @property (nonatomic, assign) int audiokBPS - - - //api/name/audiokBPS - - - - - //apple_ref/occ/instm/KSYStreamerBase/audiokBPS - 音频编码码率（单位:kbps） - KSYStreamerBase.h - - @property (nonatomic, assign) int audiokBPS - - - //api/name/audiokBPS - - - - - //apple_ref/occ/instp/KSYStreamerBase/audiokBPS - 音频编码码率（单位:kbps） - KSYStreamerBase.h - - @property (nonatomic, assign) int audiokBPS - - - //api/name/audiokBPS - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBwEstimateMode: - 带宽估计模式 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode - - - //api/name/bwEstimateMode - - - - - //apple_ref/occ/instm/KSYStreamerBase/bwEstimateMode - 带宽估计模式 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode - - - //api/name/bwEstimateMode - - - - - //apple_ref/occ/instp/KSYStreamerBase/bwEstimateMode - 带宽估计模式 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode - - - //api/name/bwEstimateMode - - - - - //apple_ref/occ/instm/KSYStreamerBase/setLiveScene: - 本次直播的目标场景 (默认为KSYLiveScene_Default) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYLiveScene liveScene - - - //api/name/liveScene - - - - - //apple_ref/occ/instm/KSYStreamerBase/liveScene - 本次直播的目标场景 (默认为KSYLiveScene_Default) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYLiveScene liveScene - - - //api/name/liveScene - - - - - //apple_ref/occ/instp/KSYStreamerBase/liveScene - 本次直播的目标场景 (默认为KSYLiveScene_Default) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYLiveScene liveScene - - - //api/name/liveScene - - - - - //apple_ref/occ/instm/KSYStreamerBase/setRecScene: - 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYRecScene recScene - - - //api/name/recScene - - - - - //apple_ref/occ/instm/KSYStreamerBase/recScene - 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYRecScene recScene - - - //api/name/recScene - - - - - //apple_ref/occ/instp/KSYStreamerBase/recScene - 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) - KSYStreamerBase.h - - @property (nonatomic, assign) KSYRecScene recScene - - - //api/name/recScene - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoEncodePerf: - 视频编码性能档次 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf - - - //api/name/videoEncodePerf - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoEncodePerf - 视频编码性能档次 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf - - - //api/name/videoEncodePerf - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf - 视频编码性能档次 - KSYStreamerBase.h - - @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf - - - //api/name/videoEncodePerf - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBWithVideo: - 是否处理视频的图像数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithVideo - - - //api/name/bWithVideo - - - - - //apple_ref/occ/instm/KSYStreamerBase/bWithVideo - 是否处理视频的图像数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithVideo - - - //api/name/bWithVideo - - - - - //apple_ref/occ/instp/KSYStreamerBase/bWithVideo - 是否处理视频的图像数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithVideo - - - //api/name/bWithVideo - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBWithAudio: - 是否处理音频数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithAudio - - - //api/name/bWithAudio - - - - - //apple_ref/occ/instm/KSYStreamerBase/bWithAudio - 是否处理音频数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithAudio - - - //api/name/bWithAudio - - - - - //apple_ref/occ/instp/KSYStreamerBase/bWithAudio - 是否处理音频数据 (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithAudio - - - //api/name/bWithAudio - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBWithMessage: - 是否处理Message (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithMessage - - - //api/name/bWithMessage - - - - - //apple_ref/occ/instm/KSYStreamerBase/bWithMessage - 是否处理Message (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithMessage - - - //api/name/bWithMessage - - - - - //apple_ref/occ/instp/KSYStreamerBase/bWithMessage - 是否处理Message (默认YES) - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL bWithMessage - - - //api/name/bWithMessage - - - - - //apple_ref/occ/instm/KSYStreamerBase/setScaleRatio: - cpu缩放比率,设置>0为按比例缩放，默认为0 - KSYStreamerBase.h - - @property (nonatomic, assign) float scaleRatio - - - //api/name/scaleRatio - - - - - //apple_ref/occ/instm/KSYStreamerBase/scaleRatio - cpu缩放比率,设置>0为按比例缩放，默认为0 - KSYStreamerBase.h - - @property (nonatomic, assign) float scaleRatio - - - //api/name/scaleRatio - - - - - //apple_ref/occ/instp/KSYStreamerBase/scaleRatio - cpu缩放比率,设置>0为按比例缩放，默认为0 - KSYStreamerBase.h - - @property (nonatomic, assign) float scaleRatio - - - //api/name/scaleRatio - - - - - //apple_ref/occ/instm/KSYStreamerBase/setStreamState: - 当前推流状况 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamState streamState - - - //api/name/streamState - - - - - //apple_ref/occ/instm/KSYStreamerBase/streamState - 当前推流状况 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamState streamState - - - //api/name/streamState - - - - - //apple_ref/occ/instp/KSYStreamerBase/streamState - 当前推流状况 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamState streamState - - - //api/name/streamState - - - - - //apple_ref/occ/instm/KSYStreamerBase/getStreamStateName: - 获取推流状态对应的字符串 - KSYStreamerBase.h - - - (NSString *)getStreamStateName:(KSYStreamState)stat - - - stat - 状态码 - - - 状态名称 - //api/name/getStreamStateName: - - - - - //apple_ref/occ/instm/KSYStreamerBase/getCurStreamStateName - 获取当前推流状态对应的字符串 - KSYStreamerBase.h - - - (NSString *)getCurStreamStateName - - 当前状态名称 - //api/name/getCurStreamStateName - - - - - //apple_ref/occ/instm/KSYStreamerBase/setStreamErrorCode: - 当前推流的错误码 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/streamState - - - - @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode - - - //api/name/streamErrorCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/streamErrorCode - 当前推流的错误码 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/streamState - - - - @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode - - - //api/name/streamErrorCode - - - - - //apple_ref/occ/instp/KSYStreamerBase/streamErrorCode - 当前推流的错误码 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/streamState - - - - @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode - - - //api/name/streamErrorCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/setStreamStateChange: - 发生推流状态变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange - - - //api/name/streamStateChange - - - - - //apple_ref/occ/instm/KSYStreamerBase/streamStateChange - 发生推流状态变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange - - - //api/name/streamStateChange - - - - - //apple_ref/occ/instp/KSYStreamerBase/streamStateChange - 发生推流状态变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange - - - //api/name/streamStateChange - - - - - //apple_ref/occ/instm/KSYStreamerBase/getKSYStreamErrorCodeName: - 获取错误码对应的字符串 - KSYStreamerBase.h - - - (NSString *)getKSYStreamErrorCodeName:(KSYStreamErrorCode)code - - - code - 错误码 - - - - //api/name/getKSYStreamErrorCodeName: - - - - - //apple_ref/occ/instm/KSYStreamerBase/getCurKSYStreamErrorCodeName - 获取当前错误码对应的字符串 - KSYStreamerBase.h - - - (NSString *)getCurKSYStreamErrorCodeName - - - //api/name/getCurKSYStreamErrorCodeName - - - - - //apple_ref/occ/instm/KSYStreamerBase/setNetStateCode: - 当前推流的网络事件 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYNetStateCode netStateCode - - - //api/name/netStateCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/netStateCode - 当前推流的网络事件 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYNetStateCode netStateCode - - - //api/name/netStateCode - - - - - //apple_ref/occ/instp/KSYStreamerBase/netStateCode - 当前推流的网络事件 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYNetStateCode netStateCode - - - //api/name/netStateCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/setVideoFPSChange: - 帧率应发生变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange - - - //api/name/videoFPSChange - - - - - //apple_ref/occ/instm/KSYStreamerBase/videoFPSChange - 帧率应发生变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange - - - //api/name/videoFPSChange - - - - - //apple_ref/occ/instp/KSYStreamerBase/videoFPSChange - 帧率应发生变化时的回调函数 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange - - - //api/name/videoFPSChange - - - - - //apple_ref/occ/instm/KSYStreamerBase/initWithDefaultCfg - 初始化方法 （step1） - KSYStreamerBase.h - - - (instancetype)initWithDefaultCfg - - - //api/name/initWithDefaultCfg - - - - - //apple_ref/occ/instm/KSYStreamerBase/startStream: - 启动推流 （step2） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/audiokBPS - - - - - (void)startStream:(NSURL *)url - - - url - 目标地址 - - - - //api/name/startStream: - - - - - //apple_ref/occ/instm/KSYStreamerBase/stopStream - 停止推流 （step3） - KSYStreamerBase.h - - - (void)stopStream - - - //api/name/stopStream - - - - - //apple_ref/occ/instm/KSYStreamerBase/muteStream: - 静音推流 (仍然有音频输出发送, 只是音量为0) - KSYStreamerBase.h - - - (void)muteStream:(BOOL)bMute - - - bMute - YES / ON - - - - //api/name/muteStream: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processVideoSampleBuffer: - 处理一个视频帧(只支持编码前的原始图像数据) - KSYStreamerBase.h - - - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer - - - sampleBuffer - Buffer to process - - - - //api/name/processVideoSampleBuffer: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processVideoSampleBuffer:onComplete: - 处理一个视频帧(只支持编码前的原始图像数据) - KSYStreamerBase.h - - - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion - - - sampleBuffer - Buffer to process - - completion - 当前视频帧处理完成的回调 - - - - //api/name/processVideoSampleBuffer:onComplete: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processVideoPixelBuffer:timeInfo: - 处理一个视频帧(只支持编码前的原始图像数据) - KSYStreamerBase.h - - - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp - - - pixelBuffer - 待编码的像素数据 - - timeStamp - 待编码的时间戳 - - - - //api/name/processVideoPixelBuffer:timeInfo: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processVideoPixelBuffer:timeInfo:onComplete: - 处理一个视频帧(只支持编码前的原始图像数据) - KSYStreamerBase.h - - - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion - - - pixelBuffer - 待编码的像素数据 - - timeStamp - 待编码的时间戳 - - completion - 当前视频帧处理完成的回调 - - - - //api/name/processVideoPixelBuffer:timeInfo:onComplete: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processAudioSampleBuffer: - 处理一段音频数据 - KSYStreamerBase.h - - - (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer - - - sampleBuffer - Buffer to process - - - - //api/name/processAudioSampleBuffer: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processAudioData:nbSample:withFormat:timeinfo: - 处理一段音频数据 - KSYStreamerBase.h - - - (void)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime *)pts - - - pData - 原始数据指针数组 - - len - 数据的长度，单位为字节 - - fmt - 原始数据的格式 (必须保证一次推流过程中数据格式不变) - - pts - 原始数据的时间戳 - - - - //api/name/processAudioData:nbSample:withFormat:timeinfo: - - - - - //apple_ref/occ/instm/KSYStreamerBase/processMessageData: - 处理一个消息 - KSYStreamerBase.h - - - (void)processMessageData:(NSDictionary *)messageData - - - message - message to process - - - - //api/name/processMessageData: - - - - - //apple_ref/occ/instm/KSYStreamerBase/setClientAk: - 获取当前用户的ak -@warnning 默认是空的，只有在需要鉴权时，才能获取到 - KSYStreamerBase.h - - @property (nonatomic, assign) NSString *clientAk - - - //api/name/clientAk - - - - - //apple_ref/occ/instm/KSYStreamerBase/clientAk - 获取当前用户的ak -@warnning 默认是空的，只有在需要鉴权时，才能获取到 - KSYStreamerBase.h - - @property (nonatomic, assign) NSString *clientAk - - - //api/name/clientAk - - - - - //apple_ref/occ/instp/KSYStreamerBase/clientAk - 获取当前用户的ak -@warnning 默认是空的，只有在需要鉴权时，才能获取到 - KSYStreamerBase.h - - @property (nonatomic, assign) NSString *clientAk - - - //api/name/clientAk - - - - - //apple_ref/occ/instm/KSYStreamerBase/setExpireDate: - 获取当前SDK过期时间 - KSYStreamerBase.h - - @property (nonatomic, assign) NSDate *expireDate - - - //api/name/expireDate - - - - - //apple_ref/occ/instm/KSYStreamerBase/expireDate - 获取当前SDK过期时间 - KSYStreamerBase.h - - @property (nonatomic, assign) NSDate *expireDate - - - //api/name/expireDate - - - - - //apple_ref/occ/instp/KSYStreamerBase/expireDate - 获取当前SDK过期时间 - KSYStreamerBase.h - - @property (nonatomic, assign) NSDate *expireDate - - - //api/name/expireDate - - - - - //apple_ref/occ/instm/KSYStreamerBase/setStreamID: - 查询当前推流的事件ID - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSString *streamID - - - //api/name/streamID - - - - - //apple_ref/occ/instm/KSYStreamerBase/streamID - 查询当前推流的事件ID - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSString *streamID - - - //api/name/streamID - - - - - //apple_ref/occ/instp/KSYStreamerBase/streamID - 查询当前推流的事件ID - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSString *streamID - - - //api/name/streamID - - - - - //apple_ref/occ/instm/KSYStreamerBase/isStreaming - 查询当前是否处于推流状态 (建立连接中, 或连接中) - KSYStreamerBase.h - - - (BOOL)isStreaming - - - //api/name/isStreaming - - - - - //apple_ref/occ/instm/KSYStreamerBase/setEncodeVKbps: - 查询当前编码的视频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, readonly) double encodeVKbps - - - //api/name/encodeVKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/encodeVKbps - 查询当前编码的视频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, readonly) double encodeVKbps - - - //api/name/encodeVKbps - - - - - //apple_ref/occ/instp/KSYStreamerBase/encodeVKbps - 查询当前编码的视频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate - - - - @property (nonatomic, readonly) double encodeVKbps - - - //api/name/encodeVKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/setEncodeAKbps: - 查询当前编码的音频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/audiokBPS - - - - @property (nonatomic, readonly) double encodeAKbps - - - //api/name/encodeAKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/encodeAKbps - 查询当前编码的音频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/audiokBPS - - - - @property (nonatomic, readonly) double encodeAKbps - - - //api/name/encodeAKbps - - - - - //apple_ref/occ/instp/KSYStreamerBase/encodeAKbps - 查询当前编码的音频码率大小（每秒更新） - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/audiokBPS - - - - @property (nonatomic, readonly) double encodeAKbps - - - //api/name/encodeAKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/setUploadedKByte: - 查询本次推流发送的流量大小 (仅推流时有效) - KSYStreamerBase.h - - @property (nonatomic, readonly) int uploadedKByte - - - //api/name/uploadedKByte - - - - - //apple_ref/occ/instm/KSYStreamerBase/uploadedKByte - 查询本次推流发送的流量大小 (仅推流时有效) - KSYStreamerBase.h - - @property (nonatomic, readonly) int uploadedKByte - - - //api/name/uploadedKByte - - - - - //apple_ref/occ/instp/KSYStreamerBase/uploadedKByte - 查询本次推流发送的流量大小 (仅推流时有效) - KSYStreamerBase.h - - @property (nonatomic, readonly) int uploadedKByte - - - //api/name/uploadedKByte - - - - - //apple_ref/occ/instm/KSYStreamerBase/setCurrentUploadingKbps: - 查询当前上传的码率大小 (每秒更新) - KSYStreamerBase.h - - @property (nonatomic, readonly) double currentUploadingKbps - - - //api/name/currentUploadingKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/currentUploadingKbps - 查询当前上传的码率大小 (每秒更新) - KSYStreamerBase.h - - @property (nonatomic, readonly) double currentUploadingKbps - - - //api/name/currentUploadingKbps - - - - - //apple_ref/occ/instp/KSYStreamerBase/currentUploadingKbps - 查询当前上传的码率大小 (每秒更新) - KSYStreamerBase.h - - @property (nonatomic, readonly) double currentUploadingKbps - - - //api/name/currentUploadingKbps - - - - - //apple_ref/occ/instm/KSYStreamerBase/setEncodingFPS: - 查询当前编码的平均视频帧率 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoFPS - - - - @property (nonatomic, readonly) double encodingFPS - - - //api/name/encodingFPS - - - - - //apple_ref/occ/instm/KSYStreamerBase/encodingFPS - 查询当前编码的平均视频帧率 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoFPS - - - - @property (nonatomic, readonly) double encodingFPS - - - //api/name/encodingFPS - - - - - //apple_ref/occ/instp/KSYStreamerBase/encodingFPS - 查询当前编码的平均视频帧率 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/videoFPS - - - - @property (nonatomic, readonly) double encodingFPS - - - //api/name/encodingFPS - - - - - //apple_ref/occ/instm/KSYStreamerBase/setEncodedFrames: - 查询本次推流编码的视频总帧数 - KSYStreamerBase.h - - @property (nonatomic, readonly) int encodedFrames - - - //api/name/encodedFrames - - - - - //apple_ref/occ/instm/KSYStreamerBase/encodedFrames - 查询本次推流编码的视频总帧数 - KSYStreamerBase.h - - @property (nonatomic, readonly) int encodedFrames - - - //api/name/encodedFrames - - - - - //apple_ref/occ/instp/KSYStreamerBase/encodedFrames - 查询本次推流编码的视频总帧数 - KSYStreamerBase.h - - @property (nonatomic, readonly) int encodedFrames - - - //api/name/encodedFrames - - - - - //apple_ref/occ/instm/KSYStreamerBase/setDroppedVideoFrames: - 查询本次推流发送的丢帧数量 - KSYStreamerBase.h - - @property (nonatomic, readonly) int droppedVideoFrames - - - //api/name/droppedVideoFrames - - - - - //apple_ref/occ/instm/KSYStreamerBase/droppedVideoFrames - 查询本次推流发送的丢帧数量 - KSYStreamerBase.h - - @property (nonatomic, readonly) int droppedVideoFrames - - - //api/name/droppedVideoFrames - - - - - //apple_ref/occ/instp/KSYStreamerBase/droppedVideoFrames - 查询本次推流发送的丢帧数量 - KSYStreamerBase.h - - @property (nonatomic, readonly) int droppedVideoFrames - - - //api/name/droppedVideoFrames - - - - - //apple_ref/occ/instm/KSYStreamerBase/setQosInfo: - 推流的qos信息 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo - - - //api/name/qosInfo - - - - - //apple_ref/occ/instm/KSYStreamerBase/qosInfo - 推流的qos信息 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo - - - //api/name/qosInfo - - - - - //apple_ref/occ/instp/KSYStreamerBase/qosInfo - 推流的qos信息 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo - - - //api/name/qosInfo - - - - - //apple_ref/occ/instm/KSYStreamerBase/setRtmpHostIP: - 查询当前推流的rtmp服务器的主机IP - KSYStreamerBase.h - - @property (atomic, readonly) NSString *rtmpHostIP - - - //api/name/rtmpHostIP - - - - - //apple_ref/occ/instm/KSYStreamerBase/rtmpHostIP - 查询当前推流的rtmp服务器的主机IP - KSYStreamerBase.h - - @property (atomic, readonly) NSString *rtmpHostIP - - - //api/name/rtmpHostIP - - - - - //apple_ref/occ/instp/KSYStreamerBase/rtmpHostIP - 查询当前推流的rtmp服务器的主机IP - KSYStreamerBase.h - - @property (atomic, readonly) NSString *rtmpHostIP - - - //api/name/rtmpHostIP - - - - - //apple_ref/occ/instm/KSYStreamerBase/setShouldEnableKSYStatModule: - 收集网络相关状态的日志，默认开启 - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL shouldEnableKSYStatModule - - - //api/name/shouldEnableKSYStatModule - - - - - //apple_ref/occ/instm/KSYStreamerBase/shouldEnableKSYStatModule - 收集网络相关状态的日志，默认开启 - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL shouldEnableKSYStatModule - - - //api/name/shouldEnableKSYStatModule - - - - - //apple_ref/occ/instp/KSYStreamerBase/shouldEnableKSYStatModule - 收集网络相关状态的日志，默认开启 - KSYStreamerBase.h - - @property (nonatomic, assign) BOOL shouldEnableKSYStatModule - - - //api/name/shouldEnableKSYStatModule - - - - - //apple_ref/occ/instm/KSYStreamerBase/setLogBlock: - 获取Streamer中与网络相关的日志 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock - - - //api/name/logBlock - - - - - //apple_ref/occ/instm/KSYStreamerBase/logBlock - 获取Streamer中与网络相关的日志 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock - - - //api/name/logBlock - - - - - //apple_ref/occ/instp/KSYStreamerBase/logBlock - 获取Streamer中与网络相关的日志 - KSYStreamerBase.h - - @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock - - - //api/name/logBlock - - - - - //apple_ref/occ/instm/KSYStreamerBase/takePhotoWithQuality:fileName: - 截图功能，目前只支持jpg格式 - KSYStreamerBase.h - - - (void)takePhotoWithQuality:(CGFloat)jpegCompressionQuality fileName:(NSString *)filename - - - jpegCompressionQuality - 设置图像的压缩比例 - - filename - 图片的文件名 - - - - //api/name/takePhotoWithQuality:fileName: - - - - - //apple_ref/occ/instm/KSYStreamerBase/getSnapshotWithCompletion: - 获取当前编码的截图 - KSYStreamerBase.h - - - (void)getSnapshotWithCompletion:(void ( ^ ) ( UIImage *))completion - - - completion - 通过完成代码块获取到截图完成的图像 - - - - //api/name/getSnapshotWithCompletion: - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordURL: - 旁路录像地址 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSURL *bypassRecordURL - - - //api/name/bypassRecordURL - - - - - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordURL - 旁路录像地址 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSURL *bypassRecordURL - - - //api/name/bypassRecordURL - - - - - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordURL - 旁路录像地址 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/hostURL - - - - @property (nonatomic, readonly) NSURL *bypassRecordURL - - - //api/name/bypassRecordURL - - - - - //apple_ref/occ/instm/KSYStreamerBase/startBypassRecord: - 启动旁路录像 - KSYStreamerBase.h - - - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordState - - - - - (BOOL)startBypassRecord:(NSURL *)url - - - url - 本地录像文件地址:/private/var/..../test.mp4 - - - 是否能尝试启动写入, 不能表明真正开始录像了,真正开始请确认bypassRecordState的值 - //api/name/startBypassRecord: - - - - - //apple_ref/occ/instm/KSYStreamerBase/stopBypassRecord - 停止旁路录像 - KSYStreamerBase.h - - - (void)stopBypassRecord - - - //api/name/stopBypassRecord - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordDuration: - 旁路录像的文件时长 - KSYStreamerBase.h - - @property (nonatomic, readonly) double bypassRecordDuration - - - //api/name/bypassRecordDuration - - - - - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordDuration - 旁路录像的文件时长 - KSYStreamerBase.h - - @property (nonatomic, readonly) double bypassRecordDuration - - - //api/name/bypassRecordDuration - - - - - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordDuration - 旁路录像的文件时长 - KSYStreamerBase.h - - @property (nonatomic, readonly) double bypassRecordDuration - - - //api/name/bypassRecordDuration - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordState: - 旁路录像的状态 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordState bypassRecordState - - - //api/name/bypassRecordState - - - - - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordState - 旁路录像的状态 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordState bypassRecordState - - - //api/name/bypassRecordState - - - - - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordState - 旁路录像的状态 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordState bypassRecordState - - - //api/name/bypassRecordState - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordErrorCode: - 旁路录像的错误码 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode - - - //api/name/bypassRecordErrorCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordErrorCode - 旁路录像的错误码 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode - - - //api/name/bypassRecordErrorCode - - - - - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordErrorCode - 旁路录像的错误码 - KSYStreamerBase.h - - @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode - - - //api/name/bypassRecordErrorCode - - - - - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordErrorName: - 旁路录像的错误名称 - KSYStreamerBase.h - - @property (nonatomic, readonly) NSString *bypassRecordErrorName + + (instancetype)reachabilityWithHostName:(NSString *)hostname - //api/name/bypassRecordErrorName + //api/name/reachabilityWithHostName: - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordErrorName - 旁路录像的错误名称 - KSYStreamerBase.h + //apple_ref/occ/clm/KSYReachability/reachabilityForInternetConnection + + KSYReachability.h - @property (nonatomic, readonly) NSString *bypassRecordErrorName + + (instancetype)reachabilityForInternetConnection - //api/name/bypassRecordErrorName + //api/name/reachabilityForInternetConnection - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordErrorName - 旁路录像的错误名称 - KSYStreamerBase.h + //apple_ref/occ/clm/KSYReachability/reachabilityWithAddress: + + KSYReachability.h - @property (nonatomic, readonly) NSString *bypassRecordErrorName + + (instancetype)reachabilityWithAddress:(void *)hostAddress - //api/name/bypassRecordErrorName + //api/name/reachabilityWithAddress: - //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordStateChange: - 当旁路录制的状态变化时 - KSYStreamerBase.h + //apple_ref/occ/clm/KSYReachability/reachabilityForLocalWiFi + + KSYReachability.h - @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + + (instancetype)reachabilityForLocalWiFi - //api/name/bypassRecordStateChange + //api/name/reachabilityForLocalWiFi - //apple_ref/occ/instm/KSYStreamerBase/bypassRecordStateChange - 当旁路录制的状态变化时 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/initWithReachabilityRef: + + KSYReachability.h - @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + - (instancetype)initWithReachabilityRef:(SCNetworkReachabilityRef)ref - //api/name/bypassRecordStateChange + //api/name/initWithReachabilityRef: - //apple_ref/occ/instp/KSYStreamerBase/bypassRecordStateChange - 当旁路录制的状态变化时 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/startNotifier + + KSYReachability.h - @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + - (BOOL)startNotifier - //api/name/bypassRecordStateChange + //api/name/startNotifier - //apple_ref/occ/instm/KSYStreamerBase/setShouldEnableKSYDropModule: - 是否允许编码前丢帧，默认开启 -@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/stopNotifier + + KSYReachability.h - @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + - (void)stopNotifier - //api/name/shouldEnableKSYDropModule + //api/name/stopNotifier - //apple_ref/occ/instm/KSYStreamerBase/shouldEnableKSYDropModule - 是否允许编码前丢帧，默认开启 -@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isReachable + + KSYReachability.h - @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + - (BOOL)isReachable - //api/name/shouldEnableKSYDropModule + //api/name/isReachable - //apple_ref/occ/instp/KSYStreamerBase/shouldEnableKSYDropModule - 是否允许编码前丢帧，默认开启 -@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isReachableViaWWAN + + KSYReachability.h - @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + - (BOOL)isReachableViaWWAN - //api/name/shouldEnableKSYDropModule + //api/name/isReachableViaWWAN - //apple_ref/occ/instm/KSYStreamerBase/setNetReachability: - / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isReachableViaWiFi + + KSYReachability.h - @property (nonatomic, readonly) KSYReachability *netReachability + - (BOOL)isReachableViaWiFi - //api/name/netReachability + //api/name/isReachableViaWiFi - //apple_ref/occ/instm/KSYStreamerBase/netReachability - / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isConnectionRequired + + KSYReachability.h - @property (nonatomic, readonly) KSYReachability *netReachability + - (BOOL)isConnectionRequired - //api/name/netReachability + //api/name/isConnectionRequired - //apple_ref/occ/instp/KSYStreamerBase/netReachability - / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/connectionRequired + + KSYReachability.h - @property (nonatomic, readonly) KSYReachability *netReachability + - (BOOL)connectionRequired - //api/name/netReachability + //api/name/connectionRequired - //apple_ref/occ/instm/KSYStreamerBase/setNetReachState: - 是否能连通外网 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isConnectionOnDemand + + KSYReachability.h - @property (nonatomic, readonly) KSYNetReachState netReachState + - (BOOL)isConnectionOnDemand - //api/name/netReachState + //api/name/isConnectionOnDemand - //apple_ref/occ/instm/KSYStreamerBase/netReachState - 是否能连通外网 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/isInterventionRequired + + KSYReachability.h - @property (nonatomic, readonly) KSYNetReachState netReachState + - (BOOL)isInterventionRequired - //api/name/netReachState + //api/name/isInterventionRequired - //apple_ref/occ/instp/KSYStreamerBase/netReachState - 是否能连通外网 - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/currentReachabilityStatus + + KSYReachability.h - @property (nonatomic, readonly) KSYNetReachState netReachState + - (KSYNetworkStatus)currentReachabilityStatus - //api/name/netReachState + //api/name/currentReachabilityStatus - //apple_ref/occ/instm/KSYStreamerBase/setReachabilityDetectURL: - 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/reachabilityFlags + + KSYReachability.h - @property (nonatomic, readwrite) NSString *reachabilityDetectURL + - (SCNetworkReachabilityFlags)reachabilityFlags - //api/name/reachabilityDetectURL + //api/name/reachabilityFlags - //apple_ref/occ/instm/KSYStreamerBase/reachabilityDetectURL - 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/currentReachabilityString + + KSYReachability.h - @property (nonatomic, readwrite) NSString *reachabilityDetectURL + - (NSString *)currentReachabilityString - //api/name/reachabilityDetectURL + //api/name/currentReachabilityString - //apple_ref/occ/instp/KSYStreamerBase/reachabilityDetectURL - 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” - KSYStreamerBase.h + //apple_ref/occ/instm/KSYReachability/currentReachabilityFlags + + KSYReachability.h - @property (nonatomic, readwrite) NSString *reachabilityDetectURL + - (NSString *)currentReachabilityFlags - //api/name/reachabilityDetectURL + //api/name/currentReachabilityFlags diff --git a/doc/docset/Contents/Resources/Tokens44.xml b/doc/docset/Contents/Resources/Tokens44.xml index 7106d94..a4954e9 100644 --- a/doc/docset/Contents/Resources/Tokens44.xml +++ b/doc/docset/Contents/Resources/Tokens44.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYTranscoder - 不同音视频文件格式间的转码 - KSYTranscoder.h + //apple_ref/occ/cl/KSYSpecialEffects + 金山云特效滤镜 + KSYSpecialEffects.h @@ -13,229 +13,84 @@ - //apple_ref/occ/instm/KSYTranscoder/startTranscode:outputFilePath: - 开始转换 - KSYTranscoder.h + //apple_ref/occ/clm/KSYSpecialEffects/showVersion + show version of this filter + KSYSpecialEffects.h - - (void)startTranscode:(NSURL *)inputFilePath outputFilePath:(NSURL *)outputFilePath - - - inputFilePath - 输入文件路径 - - outputFilePath - 输出文件路径 - - - - //api/name/startTranscode:outputFilePath: - - - - - //apple_ref/occ/instm/KSYTranscoder/stopTranscode - 停止转换 - KSYTranscoder.h - - - (void)stopTranscode - - - //api/name/stopTranscode - - - - - //apple_ref/occ/instm/KSYTranscoder/setDuration: - 转换文件的总时长，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float duration - - - //api/name/duration - - - - - //apple_ref/occ/instm/KSYTranscoder/duration - 转换文件的总时长，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float duration - - - //api/name/duration - - - - - //apple_ref/occ/instp/KSYTranscoder/duration - 转换文件的总时长，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float duration - - - //api/name/duration - - - - - //apple_ref/occ/instm/KSYTranscoder/setPosition: - 当前转换位置，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float position - - - //api/name/position - - - - - //apple_ref/occ/instm/KSYTranscoder/position - 当前转换位置，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float position - - - //api/name/position - - - - - //apple_ref/occ/instp/KSYTranscoder/position - 当前转换位置，单位是秒 - KSYTranscoder.h - - @property (nonatomic, readonly) float position - - - //api/name/position - - - - - //apple_ref/occ/instm/KSYTranscoder/setProgress: - 转换进度 - KSYTranscoder.h - - @property (nonatomic, readonly) float progress + + (void)showVersion - //api/name/progress + //api/name/showVersion - //apple_ref/occ/instm/KSYTranscoder/progress - 转换进度 - KSYTranscoder.h + //apple_ref/occ/instm/KSYSpecialEffects/initWithUIImage: + 初始化并指定特效素材 + KSYSpecialEffects.h - @property (nonatomic, readonly) float progress - - - //api/name/progress - - - - - //apple_ref/occ/instp/KSYTranscoder/progress - 转换进度 - KSYTranscoder.h - - @property (nonatomic, readonly) float progress - - - //api/name/progress - - - - - //apple_ref/occ/instm/KSYTranscoder/setTranscodeState: - 当前转码状况 - KSYTranscoder.h - - @property (nonatomic, readonly) KSYTranscodeState transcodeState - - - //api/name/transcodeState - - - - - //apple_ref/occ/instm/KSYTranscoder/transcodeState - 当前转码状况 - KSYTranscoder.h - - @property (nonatomic, readonly) KSYTranscodeState transcodeState - - - //api/name/transcodeState + - (id)initWithUIImage:(UIImage *)image + + + image + 特效素材 + + + 构造的滤镜 + //api/name/initWithUIImage: - //apple_ref/occ/instp/KSYTranscoder/transcodeState - 当前转码状况 - KSYTranscoder.h - - @property (nonatomic, readonly) KSYTranscodeState transcodeState + //apple_ref/occ/instm/KSYSpecialEffects/setSpecialEffectsUIImage: + 指定特效素材 + KSYSpecialEffects.h + - (void)setSpecialEffectsUIImage:(UIImage *)image + + + image + 特效素材 + + - //api/name/transcodeState + //api/name/setSpecialEffectsUIImage: - //apple_ref/occ/instm/KSYTranscoder/setTranscodeErrorCode: - 转码器的错误码 - KSYTranscoder.h + //apple_ref/occ/instm/KSYSpecialEffects/setIntensity: + 特效参数 + KSYSpecialEffects.h - - //apple_ref/occ/instp/KSYTranscoder/transcodeState - - - - @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode + @property (readwrite, nonatomic) CGFloat intensity - //api/name/transcodeErrorCode + //api/name/intensity - //apple_ref/occ/instm/KSYTranscoder/transcodeErrorCode - 转码器的错误码 - KSYTranscoder.h + //apple_ref/occ/instm/KSYSpecialEffects/intensity + 特效参数 + KSYSpecialEffects.h - - //apple_ref/occ/instp/KSYTranscoder/transcodeState - - - - @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode + @property (readwrite, nonatomic) CGFloat intensity - //api/name/transcodeErrorCode + //api/name/intensity - //apple_ref/occ/instp/KSYTranscoder/transcodeErrorCode - 转码器的错误码 - KSYTranscoder.h + //apple_ref/occ/instp/KSYSpecialEffects/intensity + 特效参数 + KSYSpecialEffects.h - - //apple_ref/occ/instp/KSYTranscoder/transcodeState - - - - @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode + @property (readwrite, nonatomic) CGFloat intensity - //api/name/transcodeErrorCode + //api/name/intensity diff --git a/doc/docset/Contents/Resources/Tokens45.xml b/doc/docset/Contents/Resources/Tokens45.xml index 54be608..e45dc04 100644 --- a/doc/docset/Contents/Resources/Tokens45.xml +++ b/doc/docset/Contents/Resources/Tokens45.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYUIRecorderKit - - KSYUIRecorderKit.h + //apple_ref/occ/cl/KSYStreamerBase + 金山云直播推流SDK iOS版提供了iOS移动设备上的推流功能 + KSYStreamerBase.h @@ -13,182 +13,2365 @@ - //apple_ref/occ/instm/KSYUIRecorderKit/initWithScheme: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/getKSYVersion + 获取SDK版本号 + KSYStreamerBase.h - - (instancetype)initWithScheme:(KSYPlayRecordScheme)scheme + - (NSString *)getKSYVersion - //api/name/initWithScheme: + //api/name/getKSYVersion - //apple_ref/occ/instm/KSYUIRecorderKit/setContentView: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/setHostURL: + 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 + KSYStreamerBase.h - @property (nonatomic, readwrite) UIView *contentView + @property (nonatomic, readonly) NSURL *hostURL - //api/name/contentView + //api/name/hostURL - //apple_ref/occ/instm/KSYUIRecorderKit/contentView - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/hostURL + 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 + KSYStreamerBase.h - @property (nonatomic, readwrite) UIView *contentView + @property (nonatomic, readonly) NSURL *hostURL - //api/name/contentView + //api/name/hostURL - //apple_ref/occ/instp/KSYUIRecorderKit/contentView - - KSYUIRecorderKit.h + //apple_ref/occ/instp/KSYStreamerBase/hostURL + 直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径 + KSYStreamerBase.h - @property (nonatomic, readwrite) UIView *contentView + @property (nonatomic, readonly) NSURL *hostURL - //api/name/contentView + //api/name/hostURL - //apple_ref/occ/instm/KSYUIRecorderKit/processWithTextureId:TextureSize:Time: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/setVideoFPS: + 视频帧率 默认:15 + KSYStreamerBase.h - - (void)processWithTextureId:(GLuint)InputTexture TextureSize:(CGSize)TextureSize Time:(CMTime)time + @property (nonatomic, assign) int videoFPS - //api/name/processWithTextureId:TextureSize:Time: + //api/name/videoFPS - //apple_ref/occ/instm/KSYUIRecorderKit/processAudioSampleBuffer: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/videoFPS + 视频帧率 默认:15 + KSYStreamerBase.h - - (void)processAudioSampleBuffer:(CMSampleBufferRef)buf + @property (nonatomic, assign) int videoFPS + //api/name/videoFPS + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoFPS + 视频帧率 默认:15 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoFPS + + + //api/name/videoFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoMinFPS: + 视频帧率最小值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMinFPS + + + //api/name/videoMinFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoMinFPS + 视频帧率最小值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMinFPS + + + //api/name/videoMinFPS + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinFPS + 视频帧率最小值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMinFPS + + + //api/name/videoMinFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoMaxFPS: + 视频帧率最大值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMaxFPS + + + //api/name/videoMaxFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoMaxFPS + 视频帧率最大值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMaxFPS + + + //api/name/videoMaxFPS + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxFPS + 视频帧率最大值，默认与videoFPS相同 + KSYStreamerBase.h + + @property (nonatomic, assign) int videoMaxFPS + + + //api/name/videoMaxFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoCodec: + 视频编码器 默认为 自动选择 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf + + + + @property (nonatomic, assign) KSYVideoCodec videoCodec + + + //api/name/videoCodec + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoCodec + 视频编码器 默认为 自动选择 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf + + + + @property (nonatomic, assign) KSYVideoCodec videoCodec + + + //api/name/videoCodec + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoCodec + 视频编码器 默认为 自动选择 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf + + + + @property (nonatomic, assign) KSYVideoCodec videoCodec + + + //api/name/videoCodec + + + + + //apple_ref/occ/instm/KSYStreamerBase/setAudioCodec: + 音频编码器 (默认为AAC-HE) + KSYStreamerBase.h + + + //apple_ref/c/tdef/KSYAudioCodec + + + + @property (nonatomic, assign) KSYAudioCodec audioCodec + + + //api/name/audioCodec + + + + + //apple_ref/occ/instm/KSYStreamerBase/audioCodec + 音频编码器 (默认为AAC-HE) + KSYStreamerBase.h + + + //apple_ref/c/tdef/KSYAudioCodec + + + + @property (nonatomic, assign) KSYAudioCodec audioCodec + + + //api/name/audioCodec + + + + + //apple_ref/occ/instp/KSYStreamerBase/audioCodec + 音频编码器 (默认为AAC-HE) + KSYStreamerBase.h + + + //apple_ref/c/tdef/KSYAudioCodec + + + + @property (nonatomic, assign) KSYAudioCodec audioCodec + + + //api/name/audioCodec + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoInitBitrate: + 视频编码起始码率（单位:kbps, 默认:500） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoInitBitrate + + + //api/name/videoInitBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoInitBitrate + 视频编码起始码率（单位:kbps, 默认:500） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoInitBitrate + + + //api/name/videoInitBitrate + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoInitBitrate + 视频编码起始码率（单位:kbps, 默认:500） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoInitBitrate + + + //api/name/videoInitBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoMaxBitrate: + 视频编码最高码率（单位:kbps, 默认:800） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoMaxBitrate + + + //api/name/videoMaxBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoMaxBitrate + 视频编码最高码率（单位:kbps, 默认:800） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoMaxBitrate + + + //api/name/videoMaxBitrate + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + 视频编码最高码率（单位:kbps, 默认:800） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + + + + @property (nonatomic, assign) int videoMaxBitrate + + + //api/name/videoMaxBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoMinBitrate: + 视频编码最低码率（单位:kbps, 默认:200） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, assign) int videoMinBitrate + + + //api/name/videoMinBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoMinBitrate + 视频编码最低码率（单位:kbps, 默认:200） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, assign) int videoMinBitrate + + + //api/name/videoMinBitrate + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoMinBitrate + 视频编码最低码率（单位:kbps, 默认:200） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, assign) int videoMinBitrate + + + //api/name/videoMinBitrate + + + + + //apple_ref/occ/instm/KSYStreamerBase/setStreamMetaData: + 推流全局附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *streamMetaData + + + //api/name/streamMetaData + + + + + //apple_ref/occ/instm/KSYStreamerBase/streamMetaData + 推流全局附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *streamMetaData + + + //api/name/streamMetaData + + + + + //apple_ref/occ/instp/KSYStreamerBase/streamMetaData + 推流全局附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *streamMetaData + + + //api/name/streamMetaData + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoMetaData: + 视频流附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *videoMetaData + + + //api/name/videoMetaData + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoMetaData + 视频流附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *videoMetaData + + + //api/name/videoMetaData + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoMetaData + 视频流附带的metadata (默认为nil) + KSYStreamerBase.h + + @property (atomic, copy) NSDictionary *videoMetaData + + + //api/name/videoMetaData + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoCrf: + 质量等级（默认:20） + KSYStreamerBase.h + + @property (nonatomic, assign) int videoCrf + + + //api/name/videoCrf + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoCrf + 质量等级（默认:20） + KSYStreamerBase.h + + @property (nonatomic, assign) int videoCrf + + + //api/name/videoCrf + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoCrf + 质量等级（默认:20） + KSYStreamerBase.h + + @property (nonatomic, assign) int videoCrf + + + //api/name/videoCrf + + + + + //apple_ref/occ/instm/KSYStreamerBase/setMaxKeyInterval: + 最大关键帧间隔（单位:秒, 默认:3） + KSYStreamerBase.h + + @property (nonatomic, assign) float maxKeyInterval + + + //api/name/maxKeyInterval + + + + + //apple_ref/occ/instm/KSYStreamerBase/maxKeyInterval + 最大关键帧间隔（单位:秒, 默认:3） + KSYStreamerBase.h + + @property (nonatomic, assign) float maxKeyInterval + + + //api/name/maxKeyInterval + + + + + //apple_ref/occ/instp/KSYStreamerBase/maxKeyInterval + 最大关键帧间隔（单位:秒, 默认:3） + KSYStreamerBase.h + + @property (nonatomic, assign) float maxKeyInterval + + + //api/name/maxKeyInterval + + + + + //apple_ref/occ/instm/KSYStreamerBase/setAudiokBPS: + 音频编码码率（单位:kbps） + KSYStreamerBase.h + + @property (nonatomic, assign) int audiokBPS + + + //api/name/audiokBPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/audiokBPS + 音频编码码率（单位:kbps） + KSYStreamerBase.h + + @property (nonatomic, assign) int audiokBPS + + + //api/name/audiokBPS + + + + + //apple_ref/occ/instp/KSYStreamerBase/audiokBPS + 音频编码码率（单位:kbps） + KSYStreamerBase.h + + @property (nonatomic, assign) int audiokBPS + + + //api/name/audiokBPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBwEstimateMode: + 带宽估计模式 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode + + + //api/name/bwEstimateMode + + + + + //apple_ref/occ/instm/KSYStreamerBase/bwEstimateMode + 带宽估计模式 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode + + + //api/name/bwEstimateMode + + + + + //apple_ref/occ/instp/KSYStreamerBase/bwEstimateMode + 带宽估计模式 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode + + + //api/name/bwEstimateMode + + + + + //apple_ref/occ/instm/KSYStreamerBase/setLiveScene: + 本次直播的目标场景 (默认为KSYLiveScene_Default) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYLiveScene liveScene + + + //api/name/liveScene + + + + + //apple_ref/occ/instm/KSYStreamerBase/liveScene + 本次直播的目标场景 (默认为KSYLiveScene_Default) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYLiveScene liveScene + + + //api/name/liveScene + + + + + //apple_ref/occ/instp/KSYStreamerBase/liveScene + 本次直播的目标场景 (默认为KSYLiveScene_Default) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYLiveScene liveScene + + + //api/name/liveScene + + + + + //apple_ref/occ/instm/KSYStreamerBase/setRecScene: + 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYRecScene recScene + + + //api/name/recScene + + + + + //apple_ref/occ/instm/KSYStreamerBase/recScene + 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYRecScene recScene + + + //api/name/recScene + + + + + //apple_ref/occ/instp/KSYStreamerBase/recScene + 本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate) + KSYStreamerBase.h + + @property (nonatomic, assign) KSYRecScene recScene + + + //api/name/recScene + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoEncodePerf: + 视频编码性能档次 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf + + + //api/name/videoEncodePerf + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoEncodePerf + 视频编码性能档次 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf + + + //api/name/videoEncodePerf + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoEncodePerf + 视频编码性能档次 + KSYStreamerBase.h + + @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf + + + //api/name/videoEncodePerf + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBWithVideo: + 是否处理视频的图像数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithVideo + + + //api/name/bWithVideo + + + + + //apple_ref/occ/instm/KSYStreamerBase/bWithVideo + 是否处理视频的图像数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithVideo + + + //api/name/bWithVideo + + + + + //apple_ref/occ/instp/KSYStreamerBase/bWithVideo + 是否处理视频的图像数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithVideo + + + //api/name/bWithVideo + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBWithAudio: + 是否处理音频数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithAudio + + + //api/name/bWithAudio + + + + + //apple_ref/occ/instm/KSYStreamerBase/bWithAudio + 是否处理音频数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithAudio + + + //api/name/bWithAudio + + + + + //apple_ref/occ/instp/KSYStreamerBase/bWithAudio + 是否处理音频数据 (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithAudio + + + //api/name/bWithAudio + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBWithMessage: + 是否处理Message (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithMessage + + + //api/name/bWithMessage + + + + + //apple_ref/occ/instm/KSYStreamerBase/bWithMessage + 是否处理Message (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithMessage + + + //api/name/bWithMessage + + + + + //apple_ref/occ/instp/KSYStreamerBase/bWithMessage + 是否处理Message (默认YES) + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL bWithMessage + + + //api/name/bWithMessage + + + + + //apple_ref/occ/instm/KSYStreamerBase/setScaleRatio: + cpu缩放比率,设置>0为按比例缩放，默认为0 + KSYStreamerBase.h + + @property (nonatomic, assign) float scaleRatio + + + //api/name/scaleRatio + + + + + //apple_ref/occ/instm/KSYStreamerBase/scaleRatio + cpu缩放比率,设置>0为按比例缩放，默认为0 + KSYStreamerBase.h + + @property (nonatomic, assign) float scaleRatio + + + //api/name/scaleRatio + + + + + //apple_ref/occ/instp/KSYStreamerBase/scaleRatio + cpu缩放比率,设置>0为按比例缩放，默认为0 + KSYStreamerBase.h + + @property (nonatomic, assign) float scaleRatio + + + //api/name/scaleRatio + + + + + //apple_ref/occ/instm/KSYStreamerBase/setStreamState: + 当前推流状况 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamState streamState + + + //api/name/streamState + + + + + //apple_ref/occ/instm/KSYStreamerBase/streamState + 当前推流状况 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamState streamState + + + //api/name/streamState + + + + + //apple_ref/occ/instp/KSYStreamerBase/streamState + 当前推流状况 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamState streamState + + + //api/name/streamState + + + + + //apple_ref/occ/instm/KSYStreamerBase/getStreamStateName: + 获取推流状态对应的字符串 + KSYStreamerBase.h + + - (NSString *)getStreamStateName:(KSYStreamState)stat + + + stat + 状态码 + + + 状态名称 + //api/name/getStreamStateName: + + + + + //apple_ref/occ/instm/KSYStreamerBase/getCurStreamStateName + 获取当前推流状态对应的字符串 + KSYStreamerBase.h + + - (NSString *)getCurStreamStateName + + 当前状态名称 + //api/name/getCurStreamStateName + + + + + //apple_ref/occ/instm/KSYStreamerBase/setStreamErrorCode: + 当前推流的错误码 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/streamState + + + + @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode + + + //api/name/streamErrorCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/streamErrorCode + 当前推流的错误码 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/streamState + + + + @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode + + + //api/name/streamErrorCode + + + + + //apple_ref/occ/instp/KSYStreamerBase/streamErrorCode + 当前推流的错误码 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/streamState + + + + @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode + + + //api/name/streamErrorCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/setStreamStateChange: + 发生推流状态变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange + + + //api/name/streamStateChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/streamStateChange + 发生推流状态变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange + + + //api/name/streamStateChange + + + + + //apple_ref/occ/instp/KSYStreamerBase/streamStateChange + 发生推流状态变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange + + + //api/name/streamStateChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/getKSYStreamErrorCodeName: + 获取错误码对应的字符串 + KSYStreamerBase.h + + - (NSString *)getKSYStreamErrorCodeName:(KSYStreamErrorCode)code + + + code + 错误码 + + + + //api/name/getKSYStreamErrorCodeName: + + + + + //apple_ref/occ/instm/KSYStreamerBase/getCurKSYStreamErrorCodeName + 获取当前错误码对应的字符串 + KSYStreamerBase.h + + - (NSString *)getCurKSYStreamErrorCodeName + + + //api/name/getCurKSYStreamErrorCodeName + + + + + //apple_ref/occ/instm/KSYStreamerBase/setNetStateCode: + 当前推流的网络事件 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYNetStateCode netStateCode + + + //api/name/netStateCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/netStateCode + 当前推流的网络事件 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYNetStateCode netStateCode + + + //api/name/netStateCode + + + + + //apple_ref/occ/instp/KSYStreamerBase/netStateCode + 当前推流的网络事件 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYNetStateCode netStateCode + + + //api/name/netStateCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/setVideoFPSChange: + 帧率应发生变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange + + + //api/name/videoFPSChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/videoFPSChange + 帧率应发生变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange + + + //api/name/videoFPSChange + + + + + //apple_ref/occ/instp/KSYStreamerBase/videoFPSChange + 帧率应发生变化时的回调函数 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange + + + //api/name/videoFPSChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/initWithDefaultCfg + 初始化方法 （step1） + KSYStreamerBase.h + + - (instancetype)initWithDefaultCfg + + + //api/name/initWithDefaultCfg + + + + + //apple_ref/occ/instm/KSYStreamerBase/startStream: + 启动推流 （step2） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/audiokBPS + + + + - (void)startStream:(NSURL *)url + + + url + 目标地址 + + + + //api/name/startStream: + + + + + //apple_ref/occ/instm/KSYStreamerBase/stopStream + 停止推流 （step3） + KSYStreamerBase.h + + - (void)stopStream + + + //api/name/stopStream + + + + + //apple_ref/occ/instm/KSYStreamerBase/muteStream: + 静音推流 (仍然有音频输出发送, 只是音量为0) + KSYStreamerBase.h + + - (void)muteStream:(BOOL)bMute + + + bMute + YES / ON + + + + //api/name/muteStream: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processVideoSampleBuffer: + 处理一个视频帧(只支持编码前的原始图像数据) + KSYStreamerBase.h + + - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer + + + sampleBuffer + Buffer to process + + + + //api/name/processVideoSampleBuffer: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processVideoSampleBuffer:onComplete: + 处理一个视频帧(只支持编码前的原始图像数据) + KSYStreamerBase.h + + - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion + + + sampleBuffer + Buffer to process + + completion + 当前视频帧处理完成的回调 + + + + //api/name/processVideoSampleBuffer:onComplete: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processVideoPixelBuffer:timeInfo: + 处理一个视频帧(只支持编码前的原始图像数据) + KSYStreamerBase.h + + - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp + + + pixelBuffer + 待编码的像素数据 + + timeStamp + 待编码的时间戳 + + + + //api/name/processVideoPixelBuffer:timeInfo: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processVideoPixelBuffer:timeInfo:onComplete: + 处理一个视频帧(只支持编码前的原始图像数据) + KSYStreamerBase.h + + - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion + + + pixelBuffer + 待编码的像素数据 + + timeStamp + 待编码的时间戳 + + completion + 当前视频帧处理完成的回调 + + + + //api/name/processVideoPixelBuffer:timeInfo:onComplete: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processAudioSampleBuffer: + 处理一段音频数据 + KSYStreamerBase.h + + - (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer + + + sampleBuffer + Buffer to process + + + //api/name/processAudioSampleBuffer: - //apple_ref/occ/instm/KSYUIRecorderKit/processVideoSampleBuffer:timeInfo: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/processAudioData:nbSample:withFormat:timeinfo: + 处理一段音频数据 + KSYStreamerBase.h + + - (void)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime *)pts + + + pData + 原始数据指针数组 + + len + 数据的长度，单位为字节 + + fmt + 原始数据的格式 (必须保证一次推流过程中数据格式不变) + + pts + 原始数据的时间戳 + + + + //api/name/processAudioData:nbSample:withFormat:timeinfo: + + + + + //apple_ref/occ/instm/KSYStreamerBase/processMessageData: + 处理一个消息 + KSYStreamerBase.h + + - (void)processMessageData:(NSDictionary *)messageData + + + message + message to process + + + + //api/name/processMessageData: + + + + + //apple_ref/occ/instm/KSYStreamerBase/setClientAk: + 获取当前用户的ak +@warnning 默认是空的，只有在需要鉴权时，才能获取到 + KSYStreamerBase.h + + @property (nonatomic, assign) NSString *clientAk + + + //api/name/clientAk + + + + + //apple_ref/occ/instm/KSYStreamerBase/clientAk + 获取当前用户的ak +@warnning 默认是空的，只有在需要鉴权时，才能获取到 + KSYStreamerBase.h + + @property (nonatomic, assign) NSString *clientAk + + + //api/name/clientAk + + + + + //apple_ref/occ/instp/KSYStreamerBase/clientAk + 获取当前用户的ak +@warnning 默认是空的，只有在需要鉴权时，才能获取到 + KSYStreamerBase.h + + @property (nonatomic, assign) NSString *clientAk + + + //api/name/clientAk + + + + + //apple_ref/occ/instm/KSYStreamerBase/setExpireDate: + 获取当前SDK过期时间 + KSYStreamerBase.h + + @property (nonatomic, assign) NSDate *expireDate + + + //api/name/expireDate + + + + + //apple_ref/occ/instm/KSYStreamerBase/expireDate + 获取当前SDK过期时间 + KSYStreamerBase.h + + @property (nonatomic, assign) NSDate *expireDate + + + //api/name/expireDate + + + + + //apple_ref/occ/instp/KSYStreamerBase/expireDate + 获取当前SDK过期时间 + KSYStreamerBase.h + + @property (nonatomic, assign) NSDate *expireDate + + + //api/name/expireDate + + + + + //apple_ref/occ/instm/KSYStreamerBase/setStreamID: + 查询当前推流的事件ID + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSString *streamID + + + //api/name/streamID + + + + + //apple_ref/occ/instm/KSYStreamerBase/streamID + 查询当前推流的事件ID + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSString *streamID + + + //api/name/streamID + + + + + //apple_ref/occ/instp/KSYStreamerBase/streamID + 查询当前推流的事件ID + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSString *streamID + + + //api/name/streamID + + + + + //apple_ref/occ/instm/KSYStreamerBase/isStreaming + 查询当前是否处于推流状态 (建立连接中, 或连接中) + KSYStreamerBase.h + + - (BOOL)isStreaming + + + //api/name/isStreaming + + + + + //apple_ref/occ/instm/KSYStreamerBase/setEncodeVKbps: + 查询当前编码的视频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, readonly) double encodeVKbps + + + //api/name/encodeVKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/encodeVKbps + 查询当前编码的视频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, readonly) double encodeVKbps + + + //api/name/encodeVKbps + + + + + //apple_ref/occ/instp/KSYStreamerBase/encodeVKbps + 查询当前编码的视频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoMaxBitrate + + + + @property (nonatomic, readonly) double encodeVKbps + + + //api/name/encodeVKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/setEncodeAKbps: + 查询当前编码的音频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/audiokBPS + + + + @property (nonatomic, readonly) double encodeAKbps + + + //api/name/encodeAKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/encodeAKbps + 查询当前编码的音频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/audiokBPS + + + + @property (nonatomic, readonly) double encodeAKbps + + + //api/name/encodeAKbps + + + + + //apple_ref/occ/instp/KSYStreamerBase/encodeAKbps + 查询当前编码的音频码率大小（每秒更新） + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/audiokBPS + + + + @property (nonatomic, readonly) double encodeAKbps + + + //api/name/encodeAKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/setUploadedKByte: + 查询本次推流发送的流量大小 (仅推流时有效) + KSYStreamerBase.h + + @property (nonatomic, readonly) int uploadedKByte + + + //api/name/uploadedKByte + + + + + //apple_ref/occ/instm/KSYStreamerBase/uploadedKByte + 查询本次推流发送的流量大小 (仅推流时有效) + KSYStreamerBase.h + + @property (nonatomic, readonly) int uploadedKByte + + + //api/name/uploadedKByte + + + + + //apple_ref/occ/instp/KSYStreamerBase/uploadedKByte + 查询本次推流发送的流量大小 (仅推流时有效) + KSYStreamerBase.h + + @property (nonatomic, readonly) int uploadedKByte + + + //api/name/uploadedKByte + + + + + //apple_ref/occ/instm/KSYStreamerBase/setCurrentUploadingKbps: + 查询当前上传的码率大小 (每秒更新) + KSYStreamerBase.h + + @property (nonatomic, readonly) double currentUploadingKbps + + + //api/name/currentUploadingKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/currentUploadingKbps + 查询当前上传的码率大小 (每秒更新) + KSYStreamerBase.h + + @property (nonatomic, readonly) double currentUploadingKbps + + + //api/name/currentUploadingKbps + + + + + //apple_ref/occ/instp/KSYStreamerBase/currentUploadingKbps + 查询当前上传的码率大小 (每秒更新) + KSYStreamerBase.h + + @property (nonatomic, readonly) double currentUploadingKbps + + + //api/name/currentUploadingKbps + + + + + //apple_ref/occ/instm/KSYStreamerBase/setEncodingFPS: + 查询当前编码的平均视频帧率 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoFPS + + + + @property (nonatomic, readonly) double encodingFPS + + + //api/name/encodingFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/encodingFPS + 查询当前编码的平均视频帧率 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoFPS + + + + @property (nonatomic, readonly) double encodingFPS + + + //api/name/encodingFPS + + + + + //apple_ref/occ/instp/KSYStreamerBase/encodingFPS + 查询当前编码的平均视频帧率 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/videoFPS + + + + @property (nonatomic, readonly) double encodingFPS + + + //api/name/encodingFPS + + + + + //apple_ref/occ/instm/KSYStreamerBase/setEncodedFrames: + 查询本次推流编码的视频总帧数 + KSYStreamerBase.h + + @property (nonatomic, readonly) int encodedFrames + + + //api/name/encodedFrames + + + + + //apple_ref/occ/instm/KSYStreamerBase/encodedFrames + 查询本次推流编码的视频总帧数 + KSYStreamerBase.h + + @property (nonatomic, readonly) int encodedFrames + + + //api/name/encodedFrames + + + + + //apple_ref/occ/instp/KSYStreamerBase/encodedFrames + 查询本次推流编码的视频总帧数 + KSYStreamerBase.h + + @property (nonatomic, readonly) int encodedFrames + + + //api/name/encodedFrames + + + + + //apple_ref/occ/instm/KSYStreamerBase/setDroppedVideoFrames: + 查询本次推流发送的丢帧数量 + KSYStreamerBase.h + + @property (nonatomic, readonly) int droppedVideoFrames + + + //api/name/droppedVideoFrames + + + + + //apple_ref/occ/instm/KSYStreamerBase/droppedVideoFrames + 查询本次推流发送的丢帧数量 + KSYStreamerBase.h + + @property (nonatomic, readonly) int droppedVideoFrames + + + //api/name/droppedVideoFrames + + + + + //apple_ref/occ/instp/KSYStreamerBase/droppedVideoFrames + 查询本次推流发送的丢帧数量 + KSYStreamerBase.h + + @property (nonatomic, readonly) int droppedVideoFrames + + + //api/name/droppedVideoFrames + + + + + //apple_ref/occ/instm/KSYStreamerBase/setQosInfo: + 推流的qos信息 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo + + + //api/name/qosInfo + + + + + //apple_ref/occ/instm/KSYStreamerBase/qosInfo + 推流的qos信息 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo + + + //api/name/qosInfo + + + + + //apple_ref/occ/instp/KSYStreamerBase/qosInfo + 推流的qos信息 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo + + + //api/name/qosInfo + + + + + //apple_ref/occ/instm/KSYStreamerBase/setRtmpHostIP: + 查询当前推流的rtmp服务器的主机IP + KSYStreamerBase.h + + @property (atomic, readonly) NSString *rtmpHostIP + + + //api/name/rtmpHostIP + + + + + //apple_ref/occ/instm/KSYStreamerBase/rtmpHostIP + 查询当前推流的rtmp服务器的主机IP + KSYStreamerBase.h + + @property (atomic, readonly) NSString *rtmpHostIP + + + //api/name/rtmpHostIP + + + + + //apple_ref/occ/instp/KSYStreamerBase/rtmpHostIP + 查询当前推流的rtmp服务器的主机IP + KSYStreamerBase.h + + @property (atomic, readonly) NSString *rtmpHostIP + + + //api/name/rtmpHostIP + + + + + //apple_ref/occ/instm/KSYStreamerBase/setShouldEnableKSYStatModule: + 收集网络相关状态的日志，默认开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYStatModule + + + //api/name/shouldEnableKSYStatModule + + + + + //apple_ref/occ/instm/KSYStreamerBase/shouldEnableKSYStatModule + 收集网络相关状态的日志，默认开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYStatModule + + + //api/name/shouldEnableKSYStatModule + + + + + //apple_ref/occ/instp/KSYStreamerBase/shouldEnableKSYStatModule + 收集网络相关状态的日志，默认开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYStatModule + + + //api/name/shouldEnableKSYStatModule + + + + + //apple_ref/occ/instm/KSYStreamerBase/setLogBlock: + 获取Streamer中与网络相关的日志 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock + + + //api/name/logBlock + + + + + //apple_ref/occ/instm/KSYStreamerBase/logBlock + 获取Streamer中与网络相关的日志 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock + + + //api/name/logBlock + + + + + //apple_ref/occ/instp/KSYStreamerBase/logBlock + 获取Streamer中与网络相关的日志 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock + + + //api/name/logBlock + + + + + //apple_ref/occ/instm/KSYStreamerBase/takePhotoWithQuality:fileName: + 截图功能，目前只支持jpg格式 + KSYStreamerBase.h + + - (void)takePhotoWithQuality:(CGFloat)jpegCompressionQuality fileName:(NSString *)filename + + + jpegCompressionQuality + 设置图像的压缩比例 + + filename + 图片的文件名 + + + + //api/name/takePhotoWithQuality:fileName: + + + + + //apple_ref/occ/instm/KSYStreamerBase/getSnapshotWithCompletion: + 获取当前编码的截图 + KSYStreamerBase.h + + - (void)getSnapshotWithCompletion:(void ( ^ ) ( UIImage *))completion + + + completion + 通过完成代码块获取到截图完成的图像 + + + + //api/name/getSnapshotWithCompletion: + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordURL: + 旁路录像地址 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSURL *bypassRecordURL + + + //api/name/bypassRecordURL + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordURL + 旁路录像地址 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSURL *bypassRecordURL + + + //api/name/bypassRecordURL + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordURL + 旁路录像地址 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/hostURL + + + + @property (nonatomic, readonly) NSURL *bypassRecordURL + + + //api/name/bypassRecordURL + + + + + //apple_ref/occ/instm/KSYStreamerBase/startBypassRecord: + 启动旁路录像 + KSYStreamerBase.h + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordState + + + + - (BOOL)startBypassRecord:(NSURL *)url + + + url + 本地录像文件地址:/private/var/..../test.mp4 + + + 是否能尝试启动写入, 不能表明真正开始录像了,真正开始请确认bypassRecordState的值 + //api/name/startBypassRecord: + + + + + //apple_ref/occ/instm/KSYStreamerBase/stopBypassRecord + 停止旁路录像 + KSYStreamerBase.h + + - (void)stopBypassRecord + + + //api/name/stopBypassRecord + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordDuration: + 旁路录像的文件时长 + KSYStreamerBase.h + + @property (nonatomic, readonly) double bypassRecordDuration + + + //api/name/bypassRecordDuration + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordDuration + 旁路录像的文件时长 + KSYStreamerBase.h + + @property (nonatomic, readonly) double bypassRecordDuration + + + //api/name/bypassRecordDuration + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordDuration + 旁路录像的文件时长 + KSYStreamerBase.h + + @property (nonatomic, readonly) double bypassRecordDuration + + + //api/name/bypassRecordDuration + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordState: + 旁路录像的状态 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordState bypassRecordState + + + //api/name/bypassRecordState + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordState + 旁路录像的状态 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordState bypassRecordState + + + //api/name/bypassRecordState + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordState + 旁路录像的状态 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordState bypassRecordState + + + //api/name/bypassRecordState + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordErrorCode: + 旁路录像的错误码 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode + + + //api/name/bypassRecordErrorCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordErrorCode + 旁路录像的错误码 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode + + + //api/name/bypassRecordErrorCode + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordErrorCode + 旁路录像的错误码 + KSYStreamerBase.h + + @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode + + + //api/name/bypassRecordErrorCode + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordErrorName: + 旁路录像的错误名称 + KSYStreamerBase.h + + @property (nonatomic, readonly) NSString *bypassRecordErrorName + + + //api/name/bypassRecordErrorName + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordErrorName + 旁路录像的错误名称 + KSYStreamerBase.h + + @property (nonatomic, readonly) NSString *bypassRecordErrorName + + + //api/name/bypassRecordErrorName + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordErrorName + 旁路录像的错误名称 + KSYStreamerBase.h + + @property (nonatomic, readonly) NSString *bypassRecordErrorName + + + //api/name/bypassRecordErrorName + + + + + //apple_ref/occ/instm/KSYStreamerBase/setBypassRecordStateChange: + 当旁路录制的状态变化时 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + + + //api/name/bypassRecordStateChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/bypassRecordStateChange + 当旁路录制的状态变化时 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + + + //api/name/bypassRecordStateChange + + + + + //apple_ref/occ/instp/KSYStreamerBase/bypassRecordStateChange + 当旁路录制的状态变化时 + KSYStreamerBase.h + + @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange + + + //api/name/bypassRecordStateChange + + + + + //apple_ref/occ/instm/KSYStreamerBase/setShouldEnableKSYDropModule: + 是否允许编码前丢帧，默认开启 +@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + + + //api/name/shouldEnableKSYDropModule + + + + + //apple_ref/occ/instm/KSYStreamerBase/shouldEnableKSYDropModule + 是否允许编码前丢帧，默认开启 +@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + + + //api/name/shouldEnableKSYDropModule + + + + + //apple_ref/occ/instp/KSYStreamerBase/shouldEnableKSYDropModule + 是否允许编码前丢帧，默认开启 +@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启 + KSYStreamerBase.h + + @property (nonatomic, assign) BOOL shouldEnableKSYDropModule + + + //api/name/shouldEnableKSYDropModule + + + + + //apple_ref/occ/instm/KSYStreamerBase/setNetReachability: + / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) + KSYStreamerBase.h - - (void)processVideoSampleBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp + @property (nonatomic, readonly) KSYReachability *netReachability - //api/name/processVideoSampleBuffer:timeInfo: + //api/name/netReachability - //apple_ref/occ/instm/KSYUIRecorderKit/startRecord: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/netReachability + / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) + KSYStreamerBase.h - - (void)startRecord:(NSURL *)path + @property (nonatomic, readonly) KSYReachability *netReachability - //api/name/startRecord: + //api/name/netReachability - //apple_ref/occ/instm/KSYUIRecorderKit/stopRecord - - KSYUIRecorderKit.h + //apple_ref/occ/instp/KSYStreamerBase/netReachability + / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码) + KSYStreamerBase.h - - (void)stopRecord + @property (nonatomic, readonly) KSYReachability *netReachability - //api/name/stopRecord + //api/name/netReachability - //apple_ref/occ/instm/KSYUIRecorderKit/setBPlayRecord: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/setNetReachState: + 是否能连通外网 + KSYStreamerBase.h - @property BOOL bPlayRecord + @property (nonatomic, readonly) KSYNetReachState netReachState - //api/name/bPlayRecord + //api/name/netReachState - //apple_ref/occ/instm/KSYUIRecorderKit/bPlayRecord - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/netReachState + 是否能连通外网 + KSYStreamerBase.h - @property BOOL bPlayRecord + @property (nonatomic, readonly) KSYNetReachState netReachState - //api/name/bPlayRecord + //api/name/netReachState - //apple_ref/occ/instp/KSYUIRecorderKit/bPlayRecord - - KSYUIRecorderKit.h + //apple_ref/occ/instp/KSYStreamerBase/netReachState + 是否能连通外网 + KSYStreamerBase.h - @property BOOL bPlayRecord + @property (nonatomic, readonly) KSYNetReachState netReachState - //api/name/bPlayRecord + //api/name/netReachState - //apple_ref/occ/instm/KSYUIRecorderKit/setWriter: - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/setReachabilityDetectURL: + 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” + KSYStreamerBase.h - @property (nonatomic, readwrite) KSYMovieWriter *writer + @property (nonatomic, readwrite) NSString *reachabilityDetectURL - //api/name/writer + //api/name/reachabilityDetectURL - //apple_ref/occ/instm/KSYUIRecorderKit/writer - - KSYUIRecorderKit.h + //apple_ref/occ/instm/KSYStreamerBase/reachabilityDetectURL + 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” + KSYStreamerBase.h - @property (nonatomic, readwrite) KSYMovieWriter *writer + @property (nonatomic, readwrite) NSString *reachabilityDetectURL - //api/name/writer + //api/name/reachabilityDetectURL - //apple_ref/occ/instp/KSYUIRecorderKit/writer - - KSYUIRecorderKit.h + //apple_ref/occ/instp/KSYStreamerBase/reachabilityDetectURL + 用于检测网络连通性的地址，默认使用地址为“www.baidu.com” + KSYStreamerBase.h - @property (nonatomic, readwrite) KSYMovieWriter *writer + @property (nonatomic, readwrite) NSString *reachabilityDetectURL - //api/name/writer + //api/name/reachabilityDetectURL diff --git a/doc/docset/Contents/Resources/Tokens46.xml b/doc/docset/Contents/Resources/Tokens46.xml index b65963a..80e2a0d 100644 --- a/doc/docset/Contents/Resources/Tokens46.xml +++ b/doc/docset/Contents/Resources/Tokens46.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cl/KSYVideoInfo - 视频信息 - KSYMediaInfo.h + //apple_ref/occ/cl/KSYTranscoder + 不同音视频文件格式间的转码 + KSYTranscoder.h @@ -13,110 +13,229 @@ - //apple_ref/occ/instm/KSYVideoInfo/setVcodec: - 视频编码格式, 具体类型为MEDIAINFOCODECID - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/startTranscode:outputFilePath: + 开始转换 + KSYTranscoder.h + + - (void)startTranscode:(NSURL *)inputFilePath outputFilePath:(NSURL *)outputFilePath + + + inputFilePath + 输入文件路径 + + outputFilePath + 输出文件路径 + + + + //api/name/startTranscode:outputFilePath: + + + + + //apple_ref/occ/instm/KSYTranscoder/stopTranscode + 停止转换 + KSYTranscoder.h + + - (void)stopTranscode + + + //api/name/stopTranscode + + + + + //apple_ref/occ/instm/KSYTranscoder/setDuration: + 转换文件的总时长，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float duration + + + //api/name/duration + + + + + //apple_ref/occ/instm/KSYTranscoder/duration + 转换文件的总时长，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float duration + + + //api/name/duration + + + + + //apple_ref/occ/instp/KSYTranscoder/duration + 转换文件的总时长，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float duration + + + //api/name/duration + + + + + //apple_ref/occ/instm/KSYTranscoder/setPosition: + 当前转换位置，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float position + + + //api/name/position + + + + + //apple_ref/occ/instm/KSYTranscoder/position + 当前转换位置，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float position + + + //api/name/position + + + + + //apple_ref/occ/instp/KSYTranscoder/position + 当前转换位置，单位是秒 + KSYTranscoder.h + + @property (nonatomic, readonly) float position + + + //api/name/position + + + + + //apple_ref/occ/instm/KSYTranscoder/setProgress: + 转换进度 + KSYTranscoder.h - @property (nonatomic) MEDIAINFO_CODEC_ID vcodec + @property (nonatomic, readonly) float progress - //api/name/vcodec + //api/name/progress - //apple_ref/occ/instm/KSYVideoInfo/vcodec - 视频编码格式, 具体类型为MEDIAINFOCODECID - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/progress + 转换进度 + KSYTranscoder.h - @property (nonatomic) MEDIAINFO_CODEC_ID vcodec + @property (nonatomic, readonly) float progress - //api/name/vcodec + //api/name/progress - //apple_ref/occ/instp/KSYVideoInfo/vcodec - 视频编码格式, 具体类型为MEDIAINFOCODECID - KSYMediaInfo.h + //apple_ref/occ/instp/KSYTranscoder/progress + 转换进度 + KSYTranscoder.h - @property (nonatomic) MEDIAINFO_CODEC_ID vcodec + @property (nonatomic, readonly) float progress - //api/name/vcodec + //api/name/progress - //apple_ref/occ/instm/KSYVideoInfo/setFrame_width: - 视频帧宽度 - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/setTranscodeState: + 当前转码状况 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_width + @property (nonatomic, readonly) KSYTranscodeState transcodeState - //api/name/frame_width + //api/name/transcodeState - //apple_ref/occ/instm/KSYVideoInfo/frame_width - 视频帧宽度 - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/transcodeState + 当前转码状况 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_width + @property (nonatomic, readonly) KSYTranscodeState transcodeState - //api/name/frame_width + //api/name/transcodeState - //apple_ref/occ/instp/KSYVideoInfo/frame_width - 视频帧宽度 - KSYMediaInfo.h + //apple_ref/occ/instp/KSYTranscoder/transcodeState + 当前转码状况 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_width + @property (nonatomic, readonly) KSYTranscodeState transcodeState - //api/name/frame_width + //api/name/transcodeState - //apple_ref/occ/instm/KSYVideoInfo/setFrame_height: - 视频帧高度 - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/setTranscodeErrorCode: + 转码器的错误码 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_height + + //apple_ref/occ/instp/KSYTranscoder/transcodeState + + + + @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode - //api/name/frame_height + //api/name/transcodeErrorCode - //apple_ref/occ/instm/KSYVideoInfo/frame_height - 视频帧高度 - KSYMediaInfo.h + //apple_ref/occ/instm/KSYTranscoder/transcodeErrorCode + 转码器的错误码 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_height + + //apple_ref/occ/instp/KSYTranscoder/transcodeState + + + + @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode - //api/name/frame_height + //api/name/transcodeErrorCode - //apple_ref/occ/instp/KSYVideoInfo/frame_height - 视频帧高度 - KSYMediaInfo.h + //apple_ref/occ/instp/KSYTranscoder/transcodeErrorCode + 转码器的错误码 + KSYTranscoder.h - @property (nonatomic, assign) int32_t frame_height + + //apple_ref/occ/instp/KSYTranscoder/transcodeState + + + + @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode - //api/name/frame_height + //api/name/transcodeErrorCode diff --git a/doc/docset/Contents/Resources/Tokens47.xml b/doc/docset/Contents/Resources/Tokens47.xml index 8f8e3aa..b45072c 100644 --- a/doc/docset/Contents/Resources/Tokens47.xml +++ b/doc/docset/Contents/Resources/Tokens47.xml @@ -1,12 +1,11 @@ - + - //apple_ref/occ/cl/KSYWeakProxy - A proxy used to hold a weak object. -It can be used to avoid retain cycles, such as the target in NSTimer or CADisplayLink. - KSYWeakProxy.h + //apple_ref/occ/cl/KSYUIRecorderKit + + KSYUIRecorderKit.h @@ -14,72 +13,182 @@ It can be used to avoid retain cycles, such as the target in NSTimer or CADispla - //apple_ref/occ/instm/KSYWeakProxy/setTarget: - The proxy target. - KSYWeakProxy.h + //apple_ref/occ/instm/KSYUIRecorderKit/initWithScheme: + + KSYUIRecorderKit.h - @property (nullable, nonatomic, weak, readonly) id target + - (instancetype)initWithScheme:(KSYPlayRecordScheme)scheme - //api/name/target + //api/name/initWithScheme: - //apple_ref/occ/instm/KSYWeakProxy/target - The proxy target. - KSYWeakProxy.h + //apple_ref/occ/instm/KSYUIRecorderKit/setContentView: + + KSYUIRecorderKit.h - @property (nullable, nonatomic, weak, readonly) id target + @property (nonatomic, readwrite) UIView *contentView - //api/name/target + //api/name/contentView - //apple_ref/occ/instp/KSYWeakProxy/target - The proxy target. - KSYWeakProxy.h + //apple_ref/occ/instm/KSYUIRecorderKit/contentView + + KSYUIRecorderKit.h - @property (nullable, nonatomic, weak, readonly) id target + @property (nonatomic, readwrite) UIView *contentView - //api/name/target + //api/name/contentView - //apple_ref/occ/instm/KSYWeakProxy/initWithTarget: - Creates a new weak proxy for target. - KSYWeakProxy.h + //apple_ref/occ/instp/KSYUIRecorderKit/contentView + + KSYUIRecorderKit.h - - (instancetype)initWithTarget:(id)target - - - target - Target object. - - - A new proxy object. - //api/name/initWithTarget: + @property (nonatomic, readwrite) UIView *contentView + + + //api/name/contentView + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/processWithTextureId:TextureSize:Time: + + KSYUIRecorderKit.h + + - (void)processWithTextureId:(GLuint)InputTexture TextureSize:(CGSize)TextureSize Time:(CMTime)time + + + //api/name/processWithTextureId:TextureSize:Time: + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/processAudioSampleBuffer: + + KSYUIRecorderKit.h + + - (void)processAudioSampleBuffer:(CMSampleBufferRef)buf + + + //api/name/processAudioSampleBuffer: + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/processVideoSampleBuffer:timeInfo: + + KSYUIRecorderKit.h + + - (void)processVideoSampleBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp + + + //api/name/processVideoSampleBuffer:timeInfo: + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/startRecord: + + KSYUIRecorderKit.h + + - (void)startRecord:(NSURL *)path + + + //api/name/startRecord: + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/stopRecord + + KSYUIRecorderKit.h + + - (void)stopRecord + + + //api/name/stopRecord - //apple_ref/occ/clm/KSYWeakProxy/proxyWithTarget: - Creates a new weak proxy for target. - KSYWeakProxy.h + //apple_ref/occ/instm/KSYUIRecorderKit/setBPlayRecord: + + KSYUIRecorderKit.h + + @property BOOL bPlayRecord + + + //api/name/bPlayRecord + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/bPlayRecord + + KSYUIRecorderKit.h + + @property BOOL bPlayRecord + + + //api/name/bPlayRecord + + + + + //apple_ref/occ/instp/KSYUIRecorderKit/bPlayRecord + + KSYUIRecorderKit.h + + @property BOOL bPlayRecord + + + //api/name/bPlayRecord + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/setWriter: + + KSYUIRecorderKit.h + + @property (nonatomic, readwrite) KSYMovieWriter *writer + + + //api/name/writer + + + + + //apple_ref/occ/instm/KSYUIRecorderKit/writer + + KSYUIRecorderKit.h + + @property (nonatomic, readwrite) KSYMovieWriter *writer + + + //api/name/writer + + + + + //apple_ref/occ/instp/KSYUIRecorderKit/writer + + KSYUIRecorderKit.h + + @property (nonatomic, readwrite) KSYMovieWriter *writer + - + (instancetype)proxyWithTarget:(id)target - - - target - Target object. - - - A new proxy object. - //api/name/proxyWithTarget: + //api/name/writer diff --git a/doc/docset/Contents/Resources/Tokens48.xml b/doc/docset/Contents/Resources/Tokens48.xml index 0ffe86d..6d780f6 100644 --- a/doc/docset/Contents/Resources/Tokens48.xml +++ b/doc/docset/Contents/Resources/Tokens48.xml @@ -1,11 +1,11 @@ - + - //apple_ref/occ/cat/AVAudioSession(KSY) - iOS的AVAudioSession 属性配置工具类 - AVAudioSession+KSY.h + //apple_ref/occ/cl/KSYVideoInfo + 视频信息 + KSYMediaInfo.h @@ -13,247 +13,110 @@ - //apple_ref/occ/instm/AVAudioSession/setDefaultCfg - 设置默认配置 - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/setVcodec: + 视频编码格式, 具体类型为MEDIAINFOCODECID + KSYMediaInfo.h - - (void)setDefaultCfg + @property (nonatomic) MEDIAINFO_CODEC_ID vcodec - //api/name/setDefaultCfg + //api/name/vcodec - //apple_ref/occ/instm/AVAudioSession/setBInterruptOtherAudio: - 是否打断其他后台的音乐播放 (默认为NO) - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/vcodec + 视频编码格式, 具体类型为MEDIAINFOCODECID + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bInterruptOtherAudio + @property (nonatomic) MEDIAINFO_CODEC_ID vcodec - //api/name/bInterruptOtherAudio + //api/name/vcodec - //apple_ref/occ/instm/AVAudioSession/bInterruptOtherAudio - 是否打断其他后台的音乐播放 (默认为NO) - AVAudioSession+KSY.h + //apple_ref/occ/instp/KSYVideoInfo/vcodec + 视频编码格式, 具体类型为MEDIAINFOCODECID + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bInterruptOtherAudio + @property (nonatomic) MEDIAINFO_CODEC_ID vcodec - //api/name/bInterruptOtherAudio + //api/name/vcodec - //apple_ref/occ/instp/AVAudioSession/bInterruptOtherAudio - 是否打断其他后台的音乐播放 (默认为NO) - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/setFrame_width: + 视频帧宽度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bInterruptOtherAudio + @property (nonatomic, assign) int32_t frame_width - //api/name/bInterruptOtherAudio + //api/name/frame_width - //apple_ref/occ/instm/AVAudioSession/setBDefaultToSpeaker: - 启动采集后,是否从扬声器播放声音 (默认为YES) - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/frame_width + 视频帧宽度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bDefaultToSpeaker + @property (nonatomic, assign) int32_t frame_width - //api/name/bDefaultToSpeaker + //api/name/frame_width - //apple_ref/occ/instm/AVAudioSession/bDefaultToSpeaker - 启动采集后,是否从扬声器播放声音 (默认为YES) - AVAudioSession+KSY.h + //apple_ref/occ/instp/KSYVideoInfo/frame_width + 视频帧宽度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bDefaultToSpeaker + @property (nonatomic, assign) int32_t frame_width - //api/name/bDefaultToSpeaker + //api/name/frame_width - //apple_ref/occ/instp/AVAudioSession/bDefaultToSpeaker - 启动采集后,是否从扬声器播放声音 (默认为YES) - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/setFrame_height: + 视频帧高度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bDefaultToSpeaker + @property (nonatomic, assign) int32_t frame_height - //api/name/bDefaultToSpeaker + //api/name/frame_height - //apple_ref/occ/instm/AVAudioSession/setBAllowBluetooth: - 是否启用蓝牙设备 (默认为YES) - AVAudioSession+KSY.h + //apple_ref/occ/instm/KSYVideoInfo/frame_height + 视频帧高度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bAllowBluetooth + @property (nonatomic, assign) int32_t frame_height - //api/name/bAllowBluetooth + //api/name/frame_height - //apple_ref/occ/instm/AVAudioSession/bAllowBluetooth - 是否启用蓝牙设备 (默认为YES) - AVAudioSession+KSY.h + //apple_ref/occ/instp/KSYVideoInfo/frame_height + 视频帧高度 + KSYMediaInfo.h - @property (nonatomic, assign) BOOL bAllowBluetooth + @property (nonatomic, assign) int32_t frame_height - //api/name/bAllowBluetooth - - - - - //apple_ref/occ/instp/AVAudioSession/bAllowBluetooth - 是否启用蓝牙设备 (默认为YES) - AVAudioSession+KSY.h - - @property (nonatomic, assign) BOOL bAllowBluetooth - - - //api/name/bAllowBluetooth - - - - - //apple_ref/occ/instm/AVAudioSession/setAVAudioSessionCategory: - 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) - AVAudioSession+KSY.h - - @property (nonatomic, assign) NSString *AVAudioSessionCategory - - - //api/name/AVAudioSessionCategory - - - - - //apple_ref/occ/instm/AVAudioSession/AVAudioSessionCategory - 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) - AVAudioSession+KSY.h - - @property (nonatomic, assign) NSString *AVAudioSessionCategory - - - //api/name/AVAudioSessionCategory - - - - - //apple_ref/occ/instp/AVAudioSession/AVAudioSessionCategory - 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) - AVAudioSession+KSY.h - - @property (nonatomic, assign) NSString *AVAudioSessionCategory - - - //api/name/AVAudioSessionCategory - - - - - //apple_ref/occ/instm/AVAudioSession/isBluetoothInputAvaible - 是否有蓝牙麦克风可用 - AVAudioSession+KSY.h - - + (BOOL)isBluetoothInputAvaible - - 是/否有蓝牙麦克风可用 - //api/name/isBluetoothInputAvaible - - - - - //apple_ref/occ/instm/AVAudioSession/switchBluetoothInput: - 选择是否使用蓝牙麦克风 - AVAudioSession+KSY.h - - + (BOOL)switchBluetoothInput:(BOOL)onOrOff - - - onOrOff - : YES 使用蓝牙麦克风 NO - - - 是/否有蓝牙麦克风可用 - //api/name/switchBluetoothInput: - - - - - //apple_ref/occ/instm/AVAudioSession/isHeadsetInputAvaible - 是否有耳机麦克风可用 - AVAudioSession+KSY.h - - + (BOOL)isHeadsetInputAvaible - - 是/否有耳机麦克风 - //api/name/isHeadsetInputAvaible - - - - - //apple_ref/occ/instm/AVAudioSession/isHeadsetPluggedIn - 查询当前是否有耳机(包括蓝牙耳机) - AVAudioSession+KSY.h - - + (BOOL)isHeadsetPluggedIn - - - //api/name/isHeadsetPluggedIn - - - - - //apple_ref/occ/instm/AVAudioSession/setCurrentMicType: - 当前使用的音频采集设备 - AVAudioSession+KSY.h - - @property KSYMicType currentMicType - - - //api/name/currentMicType - - - - - //apple_ref/occ/instm/AVAudioSession/currentMicType - 当前使用的音频采集设备 - AVAudioSession+KSY.h - - @property KSYMicType currentMicType - - - //api/name/currentMicType - - - - - //apple_ref/occ/instp/AVAudioSession/currentMicType - 当前使用的音频采集设备 - AVAudioSession+KSY.h - - @property KSYMicType currentMicType - - - //api/name/currentMicType + //api/name/frame_height diff --git a/doc/docset/Contents/Resources/Tokens49.xml b/doc/docset/Contents/Resources/Tokens49.xml index a785ea9..1466124 100644 --- a/doc/docset/Contents/Resources/Tokens49.xml +++ b/doc/docset/Contents/Resources/Tokens49.xml @@ -1,11 +1,12 @@ - + - //apple_ref/occ/intf/KSYMediaPlayback - KSYMediaPlayback为播放内核KSYMoviePlayerController提供播放控制功能。 - KSYMediaPlayback.h + //apple_ref/occ/cl/KSYWeakProxy + A proxy used to hold a weak object. +It can be used to avoid retain cycles, such as the target in NSTimer or CADisplayLink. + KSYWeakProxy.h @@ -13,152 +14,72 @@ - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - 准备视频播放 - KSYMediaPlayback.h + //apple_ref/occ/instm/KSYWeakProxy/setTarget: + The proxy target. + KSYWeakProxy.h - - //apple_ref/occ/intfp/KSYMediaPlayback/isPreparedToPlay - - - - - (void)prepareToPlay - - - //api/name/prepareToPlay - - - - - //apple_ref/occ/intfm/KSYMediaPlayback/setIsPreparedToPlay: - 查询视频准备是否完成 - KSYMediaPlayback.h - - - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - - - - @property (nonatomic, readonly) BOOL isPreparedToPlay - - - //api/name/isPreparedToPlay - - - - - //apple_ref/occ/intfm/KSYMediaPlayback/isPreparedToPlay - 查询视频准备是否完成 - KSYMediaPlayback.h - - - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - - - - @property (nonatomic, readonly) BOOL isPreparedToPlay + @property (nullable, nonatomic, weak, readonly) id target - //api/name/isPreparedToPlay + //api/name/target - //apple_ref/occ/intfp/KSYMediaPlayback/isPreparedToPlay - 查询视频准备是否完成 - KSYMediaPlayback.h + //apple_ref/occ/instm/KSYWeakProxy/target + The proxy target. + KSYWeakProxy.h - - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - - - - @property (nonatomic, readonly) BOOL isPreparedToPlay + @property (nullable, nonatomic, weak, readonly) id target - //api/name/isPreparedToPlay + //api/name/target - //apple_ref/occ/intfm/KSYMediaPlayback/play - 播放当前视频。 - KSYMediaPlayback.h + //apple_ref/occ/instp/KSYWeakProxy/target + The proxy target. + KSYWeakProxy.h - - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - - - - - (void)play + @property (nullable, nonatomic, weak, readonly) id target - //api/name/play + //api/name/target - //apple_ref/occ/intfm/KSYMediaPlayback/pause - 暂停播放当前视频。 - KSYMediaPlayback.h - - - (void)pause - - - //api/name/pause + //apple_ref/occ/instm/KSYWeakProxy/initWithTarget: + Creates a new weak proxy for target. + KSYWeakProxy.h + + - (instancetype)initWithTarget:(id)target + + + target + Target object. + + + A new proxy object. + //api/name/initWithTarget: - //apple_ref/occ/intfm/KSYMediaPlayback/stop - 结束当前视频的播放。 - KSYMediaPlayback.h - - - //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay - - - - - (void)stop - - - //api/name/stop - - - - - //apple_ref/occ/intfm/KSYMediaPlayback/setCurrentPlaybackTime: - 播放视频的当前时刻，单位为秒。 - KSYMediaPlayback.h - - @property (nonatomic) NSTimeInterval currentPlaybackTime - - - //api/name/currentPlaybackTime - - - - - //apple_ref/occ/intfm/KSYMediaPlayback/currentPlaybackTime - 播放视频的当前时刻，单位为秒。 - KSYMediaPlayback.h - - @property (nonatomic) NSTimeInterval currentPlaybackTime - - - //api/name/currentPlaybackTime - - - - - //apple_ref/occ/intfp/KSYMediaPlayback/currentPlaybackTime - 播放视频的当前时刻，单位为秒。 - KSYMediaPlayback.h - - @property (nonatomic) NSTimeInterval currentPlaybackTime - - - //api/name/currentPlaybackTime + //apple_ref/occ/clm/KSYWeakProxy/proxyWithTarget: + Creates a new weak proxy for target. + KSYWeakProxy.h + + + (instancetype)proxyWithTarget:(id)target + + + target + Target object. + + + A new proxy object. + //api/name/proxyWithTarget: diff --git a/doc/docset/Contents/Resources/Tokens50.xml b/doc/docset/Contents/Resources/Tokens50.xml index 549dd1f..2b1412e 100644 --- a/doc/docset/Contents/Resources/Tokens50.xml +++ b/doc/docset/Contents/Resources/Tokens50.xml @@ -1,67 +1,262 @@ - + - //apple_ref/c/tdef/KSYAVMuxerStatus - 交织处理状态 - KSYAVMuxer.h + //apple_ref/occ/cat/AVAudioSession(KSY) + iOS的AVAudioSession 属性配置工具类 + AVAudioSession+KSY.h - - - //apple_ref/c/econst/KSYAVMuxerStatusIdle - 初始状态 - KSYAVMuxerStatusIdle - - KSYAVMuxer.h - + + //apple_ref/occ/instm/AVAudioSession/setDefaultCfg + 设置默认配置 + AVAudioSession+KSY.h + + - (void)setDefaultCfg + + + //api/name/setDefaultCfg - - - - //apple_ref/c/econst/KSYAVMuxerStatusMuxing - 处理中 - KSYAVMuxerStatusMuxing - - KSYAVMuxer.h - + + + + //apple_ref/occ/instm/AVAudioSession/setBInterruptOtherAudio: + 是否打断其他后台的音乐播放 (默认为NO) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bInterruptOtherAudio + + + //api/name/bInterruptOtherAudio - - - - //apple_ref/c/econst/KSYAVMuxerStatusCompleted - 处理完成 - KSYAVMuxerStatusCompleted - - KSYAVMuxer.h - + + + + //apple_ref/occ/instm/AVAudioSession/bInterruptOtherAudio + 是否打断其他后台的音乐播放 (默认为NO) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bInterruptOtherAudio + + + //api/name/bInterruptOtherAudio - - - - //apple_ref/c/econst/KSYAVMuxerStatusFailed - 处理失败 - KSYAVMuxerStatusFailed - - KSYAVMuxer.h - + + + + //apple_ref/occ/instp/AVAudioSession/bInterruptOtherAudio + 是否打断其他后台的音乐播放 (默认为NO) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bInterruptOtherAudio + + + //api/name/bInterruptOtherAudio - - - - //apple_ref/c/econst/KSYAVMuxerStatusCancelled - 处理任务被取消 - KSYAVMuxerStatusCancelled - - KSYAVMuxer.h - + + + + //apple_ref/occ/instm/AVAudioSession/setBDefaultToSpeaker: + 启动采集后,是否从扬声器播放声音 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bDefaultToSpeaker + + + //api/name/bDefaultToSpeaker + + + + + //apple_ref/occ/instm/AVAudioSession/bDefaultToSpeaker + 启动采集后,是否从扬声器播放声音 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bDefaultToSpeaker + + + //api/name/bDefaultToSpeaker + + + + + //apple_ref/occ/instp/AVAudioSession/bDefaultToSpeaker + 启动采集后,是否从扬声器播放声音 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bDefaultToSpeaker + + + //api/name/bDefaultToSpeaker + + + + + //apple_ref/occ/instm/AVAudioSession/setBAllowBluetooth: + 是否启用蓝牙设备 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bAllowBluetooth + + + //api/name/bAllowBluetooth + + + + + //apple_ref/occ/instm/AVAudioSession/bAllowBluetooth + 是否启用蓝牙设备 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bAllowBluetooth + + + //api/name/bAllowBluetooth + + + + + //apple_ref/occ/instp/AVAudioSession/bAllowBluetooth + 是否启用蓝牙设备 (默认为YES) + AVAudioSession+KSY.h + + @property (nonatomic, assign) BOOL bAllowBluetooth + + + //api/name/bAllowBluetooth + + + + + //apple_ref/occ/instm/AVAudioSession/setAVAudioSessionCategory: + 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) + AVAudioSession+KSY.h + + @property (nonatomic, assign) NSString *AVAudioSessionCategory + + + //api/name/AVAudioSessionCategory + + + + + //apple_ref/occ/instm/AVAudioSession/AVAudioSessionCategory + 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) + AVAudioSession+KSY.h + + @property (nonatomic, assign) NSString *AVAudioSessionCategory + + + //api/name/AVAudioSessionCategory + + + + + //apple_ref/occ/instp/AVAudioSession/AVAudioSessionCategory + 本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord) + AVAudioSession+KSY.h + + @property (nonatomic, assign) NSString *AVAudioSessionCategory + + + //api/name/AVAudioSessionCategory + + + + + //apple_ref/occ/instm/AVAudioSession/isBluetoothInputAvaible + 是否有蓝牙麦克风可用 + AVAudioSession+KSY.h + + + (BOOL)isBluetoothInputAvaible + + 是/否有蓝牙麦克风可用 + //api/name/isBluetoothInputAvaible + + + + + //apple_ref/occ/instm/AVAudioSession/switchBluetoothInput: + 选择是否使用蓝牙麦克风 + AVAudioSession+KSY.h + + + (BOOL)switchBluetoothInput:(BOOL)onOrOff + + + onOrOff + : YES 使用蓝牙麦克风 NO + + + 是/否有蓝牙麦克风可用 + //api/name/switchBluetoothInput: - + + + + //apple_ref/occ/instm/AVAudioSession/isHeadsetInputAvaible + 是否有耳机麦克风可用 + AVAudioSession+KSY.h + + + (BOOL)isHeadsetInputAvaible + + 是/否有耳机麦克风 + //api/name/isHeadsetInputAvaible + + + + + //apple_ref/occ/instm/AVAudioSession/isHeadsetPluggedIn + 查询当前是否有耳机(包括蓝牙耳机) + AVAudioSession+KSY.h + + + (BOOL)isHeadsetPluggedIn + + + //api/name/isHeadsetPluggedIn + + + + + //apple_ref/occ/instm/AVAudioSession/setCurrentMicType: + 当前使用的音频采集设备 + AVAudioSession+KSY.h + + @property KSYMicType currentMicType + + + //api/name/currentMicType + + + + + //apple_ref/occ/instm/AVAudioSession/currentMicType + 当前使用的音频采集设备 + AVAudioSession+KSY.h + + @property KSYMicType currentMicType + + + //api/name/currentMicType + + + + + //apple_ref/occ/instp/AVAudioSession/currentMicType + 当前使用的音频采集设备 + AVAudioSession+KSY.h + + @property KSYMicType currentMicType + + + //api/name/currentMicType + + + diff --git a/doc/docset/Contents/Resources/Tokens51.xml b/doc/docset/Contents/Resources/Tokens51.xml index 8f9b2d4..e043d0f 100644 --- a/doc/docset/Contents/Resources/Tokens51.xml +++ b/doc/docset/Contents/Resources/Tokens51.xml @@ -1,57 +1,167 @@ - + - //apple_ref/c/tdef/KSYAudioCodec - 音频编码器类型 - KSYTypeDef.h + //apple_ref/occ/intf/KSYMediaPlayback + KSYMediaPlayback为播放内核KSYMoviePlayerController提供播放控制功能。 + KSYMediaPlayback.h - - - //apple_ref/c/econst/KSYAudioCodec_AAC_HE - aac音频软件编码器 - AAC_HE - KSYAudioCodec_AAC_HE - - KSYTypeDef.h - + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + 准备视频播放 + KSYMediaPlayback.h + + + //apple_ref/occ/intfp/KSYMediaPlayback/isPreparedToPlay + + + + - (void)prepareToPlay + + + //api/name/prepareToPlay - - - - //apple_ref/c/econst/KSYAudioCodec_AAC - aac音频软件编码器 - AAC_LC - KSYAudioCodec_AAC - - KSYTypeDef.h - + + + + //apple_ref/occ/intfm/KSYMediaPlayback/setIsPreparedToPlay: + 查询视频准备是否完成 + KSYMediaPlayback.h + + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + + + + @property (nonatomic, readonly) BOOL isPreparedToPlay + + + //api/name/isPreparedToPlay - - - - //apple_ref/c/econst/KSYAudioCodec_AT_AAC - iOS自带的audiotoolbox音频编码器 - AAC_LC (CPU占用较低,但推荐码率:64kbps单声道,128kbps双声道) - KSYAudioCodec_AT_AAC - - KSYTypeDef.h - + + + + //apple_ref/occ/intfm/KSYMediaPlayback/isPreparedToPlay + 查询视频准备是否完成 + KSYMediaPlayback.h + + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + + + + @property (nonatomic, readonly) BOOL isPreparedToPlay + + + //api/name/isPreparedToPlay - - - - //apple_ref/c/econst/KSYAudioCodec_AAC_HE_V2 - aac软件编码器 - AACHEV2 (仅双声道音频可用;如果输入数据为单声道,则自动退化为 AAC_HE) - KSYAudioCodec_AAC_HE_V2 - - KSYTypeDef.h - + + + + //apple_ref/occ/intfp/KSYMediaPlayback/isPreparedToPlay + 查询视频准备是否完成 + KSYMediaPlayback.h + + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + + + + @property (nonatomic, readonly) BOOL isPreparedToPlay + + + //api/name/isPreparedToPlay + + + + + //apple_ref/occ/intfm/KSYMediaPlayback/play + 播放当前视频。 + KSYMediaPlayback.h + + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + + + + - (void)play + + + //api/name/play + + + + + //apple_ref/occ/intfm/KSYMediaPlayback/pause + 暂停播放当前视频。 + KSYMediaPlayback.h + + - (void)pause + + + //api/name/pause + + + + + //apple_ref/occ/intfm/KSYMediaPlayback/stop + 结束当前视频的播放。 + KSYMediaPlayback.h + + + //apple_ref/occ/intfm/KSYMediaPlayback/prepareToPlay + + + + - (void)stop + + + //api/name/stop + + + + + //apple_ref/occ/intfm/KSYMediaPlayback/setCurrentPlaybackTime: + 播放视频的当前时刻，单位为秒。 + KSYMediaPlayback.h + + @property (nonatomic) NSTimeInterval currentPlaybackTime + + + //api/name/currentPlaybackTime - + + + + //apple_ref/occ/intfm/KSYMediaPlayback/currentPlaybackTime + 播放视频的当前时刻，单位为秒。 + KSYMediaPlayback.h + + @property (nonatomic) NSTimeInterval currentPlaybackTime + + + //api/name/currentPlaybackTime + + + + + //apple_ref/occ/intfp/KSYMediaPlayback/currentPlaybackTime + 播放视频的当前时刻，单位为秒。 + KSYMediaPlayback.h + + @property (nonatomic) NSTimeInterval currentPlaybackTime + + + //api/name/currentPlaybackTime + + + diff --git a/doc/docset/Contents/Resources/Tokens52.xml b/doc/docset/Contents/Resources/Tokens52.xml index 6b66db6..e3c0a00 100644 --- a/doc/docset/Contents/Resources/Tokens52.xml +++ b/doc/docset/Contents/Resources/Tokens52.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYAudioEffectType - 音效类型 - KSYAUAudioCapture.h + //apple_ref/c/tdef/KSYAVMuxerStatus + 交织处理状态 + KSYAVMuxer.h @@ -14,51 +14,51 @@ - //apple_ref/c/econst/KSYAudioEffectType_NONE - 初始化时状态为空闲 - KSYAudioEffectType_NONE + //apple_ref/c/econst/KSYAVMuxerStatusIdle + 初始状态 + KSYAVMuxerStatusIdle - KSYAUAudioCapture.h + KSYAVMuxer.h - //apple_ref/c/econst/KSYAudioEffectType_MALE - 大叔 - KSYAudioEffectType_MALE + //apple_ref/c/econst/KSYAVMuxerStatusMuxing + 处理中 + KSYAVMuxerStatusMuxing - KSYAUAudioCapture.h + KSYAVMuxer.h - //apple_ref/c/econst/KSYAudioEffectType_FEMALE - 萝莉 - KSYAudioEffectType_FEMALE + //apple_ref/c/econst/KSYAVMuxerStatusCompleted + 处理完成 + KSYAVMuxerStatusCompleted - KSYAUAudioCapture.h + KSYAVMuxer.h - //apple_ref/c/econst/KSYAudioEffectType_HEROIC - 宏大 - KSYAudioEffectType_HEROIC + //apple_ref/c/econst/KSYAVMuxerStatusFailed + 处理失败 + KSYAVMuxerStatusFailed - KSYAUAudioCapture.h + KSYAVMuxer.h - //apple_ref/c/econst/KSYAudioEffectType_ROBOT - 机器人 - KSYAudioEffectType_ROBOT + //apple_ref/c/econst/KSYAVMuxerStatusCancelled + 处理任务被取消 + KSYAVMuxerStatusCancelled - KSYAUAudioCapture.h + KSYAVMuxer.h diff --git a/doc/docset/Contents/Resources/Tokens53.xml b/doc/docset/Contents/Resources/Tokens53.xml index ab7a4c0..bacf635 100644 --- a/doc/docset/Contents/Resources/Tokens53.xml +++ b/doc/docset/Contents/Resources/Tokens53.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYAudioNoiseSuppress - 噪声抑制等级 - KSYAUAudioCapture.h + //apple_ref/c/tdef/KSYAudioCodec + 音频编码器类型 + KSYTypeDef.h @@ -14,51 +14,41 @@ - //apple_ref/c/econst/KSYAudioNoiseSuppress_OFF - 关闭 - KSYAudioNoiseSuppress_OFF + //apple_ref/c/econst/KSYAudioCodec_AAC_HE + aac音频软件编码器 - AAC_HE + KSYAudioCodec_AAC_HE - KSYAUAudioCapture.h + KSYTypeDef.h - //apple_ref/c/econst/KSYAudioNoiseSuppress_LOW - 温和 - KSYAudioNoiseSuppress_LOW + //apple_ref/c/econst/KSYAudioCodec_AAC + aac音频软件编码器 - AAC_LC + KSYAudioCodec_AAC - KSYAUAudioCapture.h + KSYTypeDef.h - //apple_ref/c/econst/KSYAudioNoiseSuppress_MEDIUM - 中等 - KSYAudioNoiseSuppress_MEDIUM + //apple_ref/c/econst/KSYAudioCodec_AT_AAC + iOS自带的audiotoolbox音频编码器 - AAC_LC (CPU占用较低,但推荐码率:64kbps单声道,128kbps双声道) + KSYAudioCodec_AT_AAC - KSYAUAudioCapture.h + KSYTypeDef.h - //apple_ref/c/econst/KSYAudioNoiseSuppress_HIGH - 激进 - KSYAudioNoiseSuppress_HIGH + //apple_ref/c/econst/KSYAudioCodec_AAC_HE_V2 + aac软件编码器 - AACHEV2 (仅双声道音频可用;如果输入数据为单声道,则自动退化为 AAC_HE) + KSYAudioCodec_AAC_HE_V2 - KSYAUAudioCapture.h - - - - - - //apple_ref/c/econst/KSYAudioNoiseSuppress_VERYHIGH - 非常激进 - KSYAudioNoiseSuppress_VERYHIGH - - KSYAUAudioCapture.h + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens54.xml b/doc/docset/Contents/Resources/Tokens54.xml index 811573e..e83cd9d 100644 --- a/doc/docset/Contents/Resources/Tokens54.xml +++ b/doc/docset/Contents/Resources/Tokens54.xml @@ -1,12 +1,11 @@ - + - //apple_ref/c/tdef/KSYBWEstimateMode - 网络自适应模式类型 - - KSYTypeDef.h + //apple_ref/c/tdef/KSYAudioEffectType + 音效类型 + KSYAUAudioCapture.h @@ -15,31 +14,51 @@ - //apple_ref/c/econst/KSYBWEstMode_Default - 默认模式 (综合模式,比较平稳) - KSYBWEstMode_Default + //apple_ref/c/econst/KSYAudioEffectType_NONE + 初始化时状态为空闲 + KSYAudioEffectType_NONE - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBWEstMode_Negtive - 流畅优先模式(消极上调, 极速下调) - KSYBWEstMode_Negtive + //apple_ref/c/econst/KSYAudioEffectType_MALE + 大叔 + KSYAudioEffectType_MALE - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBWEstMode_Disable - 禁用网络自适应网络调整 - KSYBWEstMode_Disable + //apple_ref/c/econst/KSYAudioEffectType_FEMALE + 萝莉 + KSYAudioEffectType_FEMALE - KSYTypeDef.h + KSYAUAudioCapture.h + + + + + + //apple_ref/c/econst/KSYAudioEffectType_HEROIC + 宏大 + KSYAudioEffectType_HEROIC + + KSYAUAudioCapture.h + + + + + + //apple_ref/c/econst/KSYAudioEffectType_ROBOT + 机器人 + KSYAudioEffectType_ROBOT + + KSYAUAudioCapture.h diff --git a/doc/docset/Contents/Resources/Tokens55.xml b/doc/docset/Contents/Resources/Tokens55.xml index ded8f8c..e9e780b 100644 --- a/doc/docset/Contents/Resources/Tokens55.xml +++ b/doc/docset/Contents/Resources/Tokens55.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYBgmPlayerState - 音频播放状态 - KSYTypeDef.h + //apple_ref/c/tdef/KSYAudioNoiseSuppress + 噪声抑制等级 + KSYAUAudioCapture.h @@ -14,71 +14,51 @@ - //apple_ref/c/econst/KSYBgmPlayerStateInit - 初始状态 - KSYBgmPlayerStateInit + //apple_ref/c/econst/KSYAudioNoiseSuppress_OFF + 关闭 + KSYAudioNoiseSuppress_OFF - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBgmPlayerStateStarting - 背景音正在播放 - KSYBgmPlayerStateStarting + //apple_ref/c/econst/KSYAudioNoiseSuppress_LOW + 温和 + KSYAudioNoiseSuppress_LOW - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBgmPlayerStateStopped - 背景音停止 - KSYBgmPlayerStateStopped + //apple_ref/c/econst/KSYAudioNoiseSuppress_MEDIUM + 中等 + KSYAudioNoiseSuppress_MEDIUM - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBgmPlayerStatePlaying - 背景音正在播放 - KSYBgmPlayerStatePlaying + //apple_ref/c/econst/KSYAudioNoiseSuppress_HIGH + 激进 + KSYAudioNoiseSuppress_HIGH - KSYTypeDef.h + KSYAUAudioCapture.h - //apple_ref/c/econst/KSYBgmPlayerStatePaused - 背景音暂停 - KSYBgmPlayerStatePaused + //apple_ref/c/econst/KSYAudioNoiseSuppress_VERYHIGH + 非常激进 + KSYAudioNoiseSuppress_VERYHIGH - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYBgmPlayerStateError - 背景音播放出错 - KSYBgmPlayerStateError - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYBgmPlayerStateInterrupted - 背景音被打断 - KSYBgmPlayerStateInterrupted - - KSYTypeDef.h + KSYAUAudioCapture.h diff --git a/doc/docset/Contents/Resources/Tokens56.xml b/doc/docset/Contents/Resources/Tokens56.xml index c058e09..847a1db 100644 --- a/doc/docset/Contents/Resources/Tokens56.xml +++ b/doc/docset/Contents/Resources/Tokens56.xml @@ -1,10 +1,11 @@ - + - //apple_ref/c/tdef/KSYCaptureState - 采集设备状态 + //apple_ref/c/tdef/KSYBWEstimateMode + 网络自适应模式类型 + KSYTypeDef.h @@ -14,9 +15,9 @@ - //apple_ref/c/econst/KSYCaptureStateIdle - 设备空闲中 - KSYCaptureStateIdle + //apple_ref/c/econst/KSYBWEstMode_Default + 默认模式 (综合模式,比较平稳) + KSYBWEstMode_Default KSYTypeDef.h @@ -24,9 +25,9 @@ - //apple_ref/c/econst/KSYCaptureStateCapturing - 设备工作中 - KSYCaptureStateCapturing + //apple_ref/c/econst/KSYBWEstMode_Negtive + 流畅优先模式(消极上调, 极速下调) + KSYBWEstMode_Negtive KSYTypeDef.h @@ -34,39 +35,9 @@ - //apple_ref/c/econst/KSYCaptureStateDevAuthDenied - 设备授权被拒绝 - KSYCaptureStateDevAuthDenied - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYCaptureStateClosingCapture - 关闭采集设备中 - KSYCaptureStateClosingCapture - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYCaptureStateParameterError - 参数错误，无法打开（比如设置的分辨率，码率当前设备不支持） - KSYCaptureStateParameterError - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYCaptureStateDevBusy - 设备正忙，请稍后尝试 ( 该状态在发出通知0.5秒后被清除 ） - KSYCaptureStateDevBusy + //apple_ref/c/econst/KSYBWEstMode_Disable + 禁用网络自适应网络调整 + KSYBWEstMode_Disable KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens57.xml b/doc/docset/Contents/Resources/Tokens57.xml index ecd4340..2f2b1b6 100644 --- a/doc/docset/Contents/Resources/Tokens57.xml +++ b/doc/docset/Contents/Resources/Tokens57.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYDevAuthStatus - 设备授权状态 + //apple_ref/c/tdef/KSYBgmPlayerState + 音频播放状态 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYDevAuthStatusNotDetermined - 还没有确定是否授权 - KSYDevAuthStatusNotDetermined + //apple_ref/c/econst/KSYBgmPlayerStateInit + 初始状态 + KSYBgmPlayerStateInit KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYDevAuthStatusRestricted - 设备受限，一般在家长模式下设备会受限 - KSYDevAuthStatusRestricted + //apple_ref/c/econst/KSYBgmPlayerStateStarting + 背景音正在播放 + KSYBgmPlayerStateStarting KSYTypeDef.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/KSYDevAuthStatusDenied - 拒绝授权 - KSYDevAuthStatusDenied + //apple_ref/c/econst/KSYBgmPlayerStateStopped + 背景音停止 + KSYBgmPlayerStateStopped KSYTypeDef.h @@ -44,9 +44,39 @@ - //apple_ref/c/econst/KSYDevAuthStatusAuthorized - 已授权 - KSYDevAuthStatusAuthorized + //apple_ref/c/econst/KSYBgmPlayerStatePlaying + 背景音正在播放 + KSYBgmPlayerStatePlaying + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYBgmPlayerStatePaused + 背景音暂停 + KSYBgmPlayerStatePaused + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYBgmPlayerStateError + 背景音播放出错 + KSYBgmPlayerStateError + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYBgmPlayerStateInterrupted + 背景音被打断 + KSYBgmPlayerStateInterrupted KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens58.xml b/doc/docset/Contents/Resources/Tokens58.xml index 0d185af..175104e 100644 --- a/doc/docset/Contents/Resources/Tokens58.xml +++ b/doc/docset/Contents/Resources/Tokens58.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYLiveScene - 直播场景 (KSY内部会根据场景的特征进行参数调优) + //apple_ref/c/tdef/KSYCaptureState + 采集设备状态 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYLiveScene_Default - 默认通用场景(不确定场景时使用) - KSYLiveScene_Default + //apple_ref/c/econst/KSYCaptureStateIdle + 设备空闲中 + KSYCaptureStateIdle KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYLiveScene_Showself - 秀场场景, 主播上半身为主 - KSYLiveScene_Showself + //apple_ref/c/econst/KSYCaptureStateCapturing + 设备工作中 + KSYCaptureStateCapturing KSYTypeDef.h @@ -34,9 +34,39 @@ - //apple_ref/c/econst/KSYLiveScene_Game - 游戏场景 - KSYLiveScene_Game + //apple_ref/c/econst/KSYCaptureStateDevAuthDenied + 设备授权被拒绝 + KSYCaptureStateDevAuthDenied + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYCaptureStateClosingCapture + 关闭采集设备中 + KSYCaptureStateClosingCapture + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYCaptureStateParameterError + 参数错误，无法打开（比如设置的分辨率，码率当前设备不支持） + KSYCaptureStateParameterError + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYCaptureStateDevBusy + 设备正忙，请稍后尝试 ( 该状态在发出通知0.5秒后被清除 ） + KSYCaptureStateDevBusy KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens59.xml b/doc/docset/Contents/Resources/Tokens59.xml index 20d9a2c..15e80d2 100644 --- a/doc/docset/Contents/Resources/Tokens59.xml +++ b/doc/docset/Contents/Resources/Tokens59.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYMPErrorCode - 错误码 - KSYMoviePlayerDefines.h + //apple_ref/c/tdef/KSYDevAuthStatus + 设备授权状态 + KSYTypeDef.h @@ -14,211 +14,41 @@ - //apple_ref/c/econst/KSYMPOK - 正常 - KSYMPOK + //apple_ref/c/econst/KSYDevAuthStatusNotDetermined + 还没有确定是否授权 + KSYDevAuthStatusNotDetermined - KSYMoviePlayerDefines.h + KSYTypeDef.h - //apple_ref/c/econst/KSYMPErrorCodeUnknownError - 未知错误 - KSYMPErrorCodeUnknownError + //apple_ref/c/econst/KSYDevAuthStatusRestricted + 设备受限，一般在家长模式下设备会受限 + KSYDevAuthStatusRestricted - KSYMoviePlayerDefines.h + KSYTypeDef.h - //apple_ref/c/econst/KSYMPErrorCodeFileIOError - 读写数据异常 - KSYMPErrorCodeFileIOError + //apple_ref/c/econst/KSYDevAuthStatusDenied + 拒绝授权 + KSYDevAuthStatusDenied - KSYMoviePlayerDefines.h + KSYTypeDef.h - //apple_ref/c/econst/KSYMPErrorCodeUnsupportProtocol - 不支持的流媒体协议 - KSYMPErrorCodeUnsupportProtocol + //apple_ref/c/econst/KSYDevAuthStatusAuthorized + 已授权 + KSYDevAuthStatusAuthorized - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeDNSParseFailed - DNS解析失败 - KSYMPErrorCodeDNSParseFailed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeCreateSocketFailed - 创建socket失败 - KSYMPErrorCodeCreateSocketFailed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeConnectServerFailed - 连接服务器失败 - KSYMPErrorCodeConnectServerFailed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeBadRequest - http请求返回400 - KSYMPErrorCodeBadRequest - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeUnauthorizedClient - http请求返回401 - KSYMPErrorCodeUnauthorizedClient - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeAccessForbidden - http请求返回403 - KSYMPErrorCodeAccessForbidden - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeTargetNotFound - http请求返回404 - KSYMPErrorCodeTargetNotFound - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeOtherErrorCode - http请求返回4xx - KSYMPErrorCodeOtherErrorCode - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeServerException - http请求返回5xx - KSYMPErrorCodeServerException - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeInvalidData - 无效的媒体数据 - KSYMPErrorCodeInvalidData - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeUnsupportVideoCodec - 不支持的视频编码类型 - KSYMPErrorCodeUnsupportVideoCodec - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeUnsupportAudioCodec - 不支持的音频编码类型 - KSYMPErrorCodeUnsupportAudioCodec - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeVideoDecodeFailed - 视频解码失败 - KSYMPErrorCodeVideoDecodeFailed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCodeAudioDecodeFailed - 音频解码失败 - KSYMPErrorCodeAudioDecodeFailed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorCode3xxOverFlow - 次数过多的3xx跳转(8次) - KSYMPErrorCode3xxOverFlow - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorInvalidURL - 无效的url - KSYMPErrorInvalidURL - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/KSYMPErrorNetworkUnReachable - 网络不通 - KSYMPErrorNetworkUnReachable - - KSYMoviePlayerDefines.h + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens60.xml b/doc/docset/Contents/Resources/Tokens60.xml index 85e15d4..7fdc055 100644 --- a/doc/docset/Contents/Resources/Tokens60.xml +++ b/doc/docset/Contents/Resources/Tokens60.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYMicType - 音频输入设备类型 + //apple_ref/c/tdef/KSYLiveScene + 直播场景 (KSY内部会根据场景的特征进行参数调优) KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYMicType_builtinMic - Built-in microphone on an iOS device - KSYMicType_builtinMic + //apple_ref/c/econst/KSYLiveScene_Default + 默认通用场景(不确定场景时使用) + KSYLiveScene_Default KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYMicType_headsetMic - Microphone on a wired headset - KSYMicType_headsetMic + //apple_ref/c/econst/KSYLiveScene_Showself + 秀场场景, 主播上半身为主 + KSYLiveScene_Showself KSYTypeDef.h @@ -34,19 +34,9 @@ - //apple_ref/c/econst/KSYMicType_bluetoothMic - 蓝牙设备 - KSYMicType_bluetoothMic - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYMicType_unknow - 未知设备 - KSYMicType_unknow + //apple_ref/c/econst/KSYLiveScene_Game + 游戏场景 + KSYLiveScene_Game KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens61.xml b/doc/docset/Contents/Resources/Tokens61.xml index 1c7bd2f..bc6bc00 100644 --- a/doc/docset/Contents/Resources/Tokens61.xml +++ b/doc/docset/Contents/Resources/Tokens61.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYNetReachState - 网络链接状态 - KSYTypeDef.h + //apple_ref/c/tdef/KSYMPErrorCode + 错误码 + KSYMoviePlayerDefines.h @@ -14,31 +14,211 @@ - //apple_ref/c/econst/KSYNetReachState_Unknown - 未知 - KSYNetReachState_Unknown + //apple_ref/c/econst/KSYMPOK + 正常 + KSYMPOK - KSYTypeDef.h + KSYMoviePlayerDefines.h - //apple_ref/c/econst/KSYNetReachState_OK - 联网 - KSYNetReachState_OK + //apple_ref/c/econst/KSYMPErrorCodeUnknownError + 未知错误 + KSYMPErrorCodeUnknownError - KSYTypeDef.h + KSYMoviePlayerDefines.h - //apple_ref/c/econst/KSYNetReachState_Bad - 断网 - KSYNetReachState_Bad + //apple_ref/c/econst/KSYMPErrorCodeFileIOError + 读写数据异常 + KSYMPErrorCodeFileIOError - KSYTypeDef.h + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeUnsupportProtocol + 不支持的流媒体协议 + KSYMPErrorCodeUnsupportProtocol + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeDNSParseFailed + DNS解析失败 + KSYMPErrorCodeDNSParseFailed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeCreateSocketFailed + 创建socket失败 + KSYMPErrorCodeCreateSocketFailed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeConnectServerFailed + 连接服务器失败 + KSYMPErrorCodeConnectServerFailed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeBadRequest + http请求返回400 + KSYMPErrorCodeBadRequest + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeUnauthorizedClient + http请求返回401 + KSYMPErrorCodeUnauthorizedClient + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeAccessForbidden + http请求返回403 + KSYMPErrorCodeAccessForbidden + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeTargetNotFound + http请求返回404 + KSYMPErrorCodeTargetNotFound + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeOtherErrorCode + http请求返回4xx + KSYMPErrorCodeOtherErrorCode + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeServerException + http请求返回5xx + KSYMPErrorCodeServerException + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeInvalidData + 无效的媒体数据 + KSYMPErrorCodeInvalidData + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeUnsupportVideoCodec + 不支持的视频编码类型 + KSYMPErrorCodeUnsupportVideoCodec + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeUnsupportAudioCodec + 不支持的音频编码类型 + KSYMPErrorCodeUnsupportAudioCodec + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeVideoDecodeFailed + 视频解码失败 + KSYMPErrorCodeVideoDecodeFailed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCodeAudioDecodeFailed + 音频解码失败 + KSYMPErrorCodeAudioDecodeFailed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorCode3xxOverFlow + 次数过多的3xx跳转(8次) + KSYMPErrorCode3xxOverFlow + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorInvalidURL + 无效的url + KSYMPErrorInvalidURL + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/KSYMPErrorNetworkUnReachable + 网络不通 + KSYMPErrorNetworkUnReachable + + KSYMoviePlayerDefines.h diff --git a/doc/docset/Contents/Resources/Tokens62.xml b/doc/docset/Contents/Resources/Tokens62.xml index 0fba3eb..b44d82d 100644 --- a/doc/docset/Contents/Resources/Tokens62.xml +++ b/doc/docset/Contents/Resources/Tokens62.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYNetStateCode - 网络状况事件码，用于指示当前网络健康状况 + //apple_ref/c/tdef/KSYMicType + 音频输入设备类型 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYNetStateCode_NONE - 正常无错误 - KSYNetStateCode_NONE + //apple_ref/c/econst/KSYMicType_builtinMic + Built-in microphone on an iOS device + KSYMicType_builtinMic KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYNetStateCode_SEND_PACKET_SLOW - 发送包时间过长，( 单次发送超过 500毫秒 ） - KSYNetStateCode_SEND_PACKET_SLOW + //apple_ref/c/econst/KSYMicType_headsetMic + Microphone on a wired headset + KSYMicType_headsetMic KSYTypeDef.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/KSYNetStateCode_EST_BW_RAISE - 估计带宽调整，上调 - KSYNetStateCode_EST_BW_RAISE + //apple_ref/c/econst/KSYMicType_bluetoothMic + 蓝牙设备 + KSYMicType_bluetoothMic KSYTypeDef.h @@ -44,69 +44,9 @@ - //apple_ref/c/econst/KSYNetStateCode_EST_BW_DROP - 估计带宽调整，下调 - KSYNetStateCode_EST_BW_DROP - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_VIDEO_FPS_RAISE - 帧率调整，上调 - KSYNetStateCode_VIDEO_FPS_RAISE - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_VIDEO_FPS_DROP - 帧率调整，下调 - KSYNetStateCode_VIDEO_FPS_DROP - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_KSYAUTHFAILED - SDK 鉴权失败 (暂时正常推流5~8分钟后终止推流) - KSYNetStateCode_KSYAUTHFAILED - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_IN_AUDIO_DISCONTINUOUS - 输入音频不连续 - KSYNetStateCode_IN_AUDIO_DISCONTINUOUS - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_UNREACHABLE - 网络变为不可用 - KSYNetStateCode_UNREACHABLE - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYNetStateCode_REACHABLE - 网络变为可用 - KSYNetStateCode_REACHABLE + //apple_ref/c/econst/KSYMicType_unknow + 未知设备 + KSYMicType_unknow KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens63.xml b/doc/docset/Contents/Resources/Tokens63.xml index e39110c..aac7e6b 100644 --- a/doc/docset/Contents/Resources/Tokens63.xml +++ b/doc/docset/Contents/Resources/Tokens63.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYNetworkStatus - Create NS_ENUM macro if it does not exist on the targeted version of iOS or OS X. - KSYReachability.h + //apple_ref/c/tdef/KSYNetReachState + 网络链接状态 + KSYTypeDef.h @@ -14,31 +14,31 @@ - //apple_ref/c/econst/KSYNotReachable - - KSYNotReachable + //apple_ref/c/econst/KSYNetReachState_Unknown + 未知 + KSYNetReachState_Unknown - KSYReachability.h + KSYTypeDef.h - //apple_ref/c/econst/KSYReachableViaWiFi - - KSYReachableViaWiFi + //apple_ref/c/econst/KSYNetReachState_OK + 联网 + KSYNetReachState_OK - KSYReachability.h + KSYTypeDef.h - //apple_ref/c/econst/KSYReachableViaWWAN - - KSYReachableViaWWAN + //apple_ref/c/econst/KSYNetReachState_Bad + 断网 + KSYNetReachState_Bad - KSYReachability.h + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens64.xml b/doc/docset/Contents/Resources/Tokens64.xml index f4c3d39..8aff773 100644 --- a/doc/docset/Contents/Resources/Tokens64.xml +++ b/doc/docset/Contents/Resources/Tokens64.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYPlayRecordScheme - 录制方案 - KSYUIRecorderKit.h + //apple_ref/c/tdef/KSYNetStateCode + 网络状况事件码，用于指示当前网络健康状况 + KSYTypeDef.h @@ -14,21 +14,101 @@ - //apple_ref/c/econst/KSYPlayerRecord_PicMix_Scheme - UI+Video混合方案 - KSYPlayerRecord_PicMix_Scheme + //apple_ref/c/econst/KSYNetStateCode_NONE + 正常无错误 + KSYNetStateCode_NONE - KSYUIRecorderKit.h + KSYTypeDef.h - //apple_ref/c/econst/KSYPlayerRecord_ScreenShot_Scheme - 截屏式方案 - KSYPlayerRecord_ScreenShot_Scheme + //apple_ref/c/econst/KSYNetStateCode_SEND_PACKET_SLOW + 发送包时间过长，( 单次发送超过 500毫秒 ） + KSYNetStateCode_SEND_PACKET_SLOW - KSYUIRecorderKit.h + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_EST_BW_RAISE + 估计带宽调整，上调 + KSYNetStateCode_EST_BW_RAISE + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_EST_BW_DROP + 估计带宽调整，下调 + KSYNetStateCode_EST_BW_DROP + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_VIDEO_FPS_RAISE + 帧率调整，上调 + KSYNetStateCode_VIDEO_FPS_RAISE + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_VIDEO_FPS_DROP + 帧率调整，下调 + KSYNetStateCode_VIDEO_FPS_DROP + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_KSYAUTHFAILED + SDK 鉴权失败 (暂时正常推流5~8分钟后终止推流) + KSYNetStateCode_KSYAUTHFAILED + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_IN_AUDIO_DISCONTINUOUS + 输入音频不连续 + KSYNetStateCode_IN_AUDIO_DISCONTINUOUS + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_UNREACHABLE + 网络变为不可用 + KSYNetStateCode_UNREACHABLE + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYNetStateCode_REACHABLE + 网络变为可用 + KSYNetStateCode_REACHABLE + + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens65.xml b/doc/docset/Contents/Resources/Tokens65.xml index b40e9c6..e7b0530 100644 --- a/doc/docset/Contents/Resources/Tokens65.xml +++ b/doc/docset/Contents/Resources/Tokens65.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYRecScene - 录制场景 - KSYTypeDef.h + //apple_ref/c/tdef/KSYNetworkStatus + Create NS_ENUM macro if it does not exist on the targeted version of iOS or OS X. + KSYReachability.h @@ -14,21 +14,31 @@ - //apple_ref/c/econst/KSYRecScene_ConstantBitRate - 恒定码率场景 - KSYRecScene_ConstantBitRate + //apple_ref/c/econst/KSYNotReachable + + KSYNotReachable - KSYTypeDef.h + KSYReachability.h - //apple_ref/c/econst/KSYRecScene_ConstantQuality - 恒定质量场景 - KSYRecScene_ConstantQuality + //apple_ref/c/econst/KSYReachableViaWiFi + + KSYReachableViaWiFi - KSYTypeDef.h + KSYReachability.h + + + + + + //apple_ref/c/econst/KSYReachableViaWWAN + + KSYReachableViaWWAN + + KSYReachability.h diff --git a/doc/docset/Contents/Resources/Tokens66.xml b/doc/docset/Contents/Resources/Tokens66.xml index 4e9c4e4..6461f16 100644 --- a/doc/docset/Contents/Resources/Tokens66.xml +++ b/doc/docset/Contents/Resources/Tokens66.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYRecordError - 旁路录制错误码 - KSYTypeDef.h + //apple_ref/c/tdef/KSYPlayRecordScheme + 录制方案 + KSYUIRecorderKit.h @@ -14,41 +14,21 @@ - //apple_ref/c/econst/KSYRecordErrorNone - 无错误 - KSYRecordErrorNone + //apple_ref/c/econst/KSYPlayerRecord_PicMix_Scheme + UI+Video混合方案 + KSYPlayerRecord_PicMix_Scheme - KSYTypeDef.h + KSYUIRecorderKit.h - //apple_ref/c/econst/KSYRecordErrorPathInvalid - 地址错误 - KSYRecordErrorPathInvalid + //apple_ref/c/econst/KSYPlayerRecord_ScreenShot_Scheme + 截屏式方案 + KSYPlayerRecord_ScreenShot_Scheme - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYRecordErrorFormatNotSupport - 格式不支持 - KSYRecordErrorFormatNotSupport - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYRecordErrorInternal - 内部错误 - KSYRecordErrorInternal - - KSYTypeDef.h + KSYUIRecorderKit.h diff --git a/doc/docset/Contents/Resources/Tokens67.xml b/doc/docset/Contents/Resources/Tokens67.xml index 18cb948..7ce6403 100644 --- a/doc/docset/Contents/Resources/Tokens67.xml +++ b/doc/docset/Contents/Resources/Tokens67.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYRecordState - 旁路录制状态 + //apple_ref/c/tdef/KSYRecScene + 录制场景 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYRecordStateIdle - 初始状态 - KSYRecordStateIdle + //apple_ref/c/econst/KSYRecScene_ConstantBitRate + 恒定码率场景 + KSYRecScene_ConstantBitRate KSYTypeDef.h @@ -24,29 +24,9 @@ - //apple_ref/c/econst/KSYRecordStateRecording - 录像中 - KSYRecordStateRecording - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYRecordStateStopped - 录像停止 - KSYRecordStateStopped - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYRecordStateError - 录像失败 - KSYRecordStateError + //apple_ref/c/econst/KSYRecScene_ConstantQuality + 恒定质量场景 + KSYRecScene_ConstantQuality KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens68.xml b/doc/docset/Contents/Resources/Tokens68.xml index 2327f43..dca4220 100644 --- a/doc/docset/Contents/Resources/Tokens68.xml +++ b/doc/docset/Contents/Resources/Tokens68.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYStreamErrorCode - 推流错误码，用于指示推流失败的原因 + //apple_ref/c/tdef/KSYRecordError + 旁路录制错误码 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYStreamErrorCode_NONE - 正常无错误 - KSYStreamErrorCode_NONE + //apple_ref/c/econst/KSYRecordErrorNone + 无错误 + KSYRecordErrorNone KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYStreamErrorCode_KSYAUTHFAILED - (obsolete) - KSYStreamErrorCode_KSYAUTHFAILED + //apple_ref/c/econst/KSYRecordErrorPathInvalid + 地址错误 + KSYRecordErrorPathInvalid KSYTypeDef.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/__deprecated_enum_msg - - __deprecated_enum_msg + //apple_ref/c/econst/KSYRecordErrorFormatNotSupport + 格式不支持 + KSYRecordErrorFormatNotSupport KSYTypeDef.h @@ -44,329 +44,9 @@ - //apple_ref/c/econst/( - - ( - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/"auth removed" - - "auth removed" - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/) - - ) - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_ENCODE_FRAMES_FAILED - 当前帧编码失败 - KSYStreamErrorCode_ENCODE_FRAMES_FAILED - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_CODEC_OPEN_FAILED - 无法打开配置指示的CODEC - KSYStreamErrorCode_CODEC_OPEN_FAILED - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_CONNECT_FAILED - 连接出错，检查地址 - KSYStreamErrorCode_CONNECT_FAILED - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_CONNECT_BREAK - 网络连接中断 - KSYStreamErrorCode_CONNECT_BREAK - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_NonExistDomain - rtmp 推流域名不存在 (KSY 自定义) - KSYStreamErrorCode_RTMP_NonExistDomain - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_NonExistApplication - rtmp 应用名不存在(KSY 自定义) - KSYStreamErrorCode_RTMP_NonExistApplication - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_AlreadyExistStreamName - rtmp 流名已存在(KSY 自定义) - KSYStreamErrorCode_RTMP_AlreadyExistStreamName - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_ForbiddenByBlacklist - rtmp 被黑名单拒绝(KSY 自定义) - KSYStreamErrorCode_RTMP_ForbiddenByBlacklist - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InternalError - rtmp 内部错误(KSY 自定义) - KSYStreamErrorCode_RTMP_InternalError - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_URLExpired - rtmp URL 地址已过期(KSY 自定义) - KSYStreamErrorCode_RTMP_URLExpired - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_SignatureDoesNotMatch - rtmp URL 地址签名错误(KSY 自定义) - KSYStreamErrorCode_RTMP_SignatureDoesNotMatch - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InvalidAccessKeyId - rtmp URL 中AccessKeyId非法(KSY 自定义) - KSYStreamErrorCode_RTMP_InvalidAccessKeyId - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_BadParams - rtmp URL 中参数错误(KSY 自定义) - KSYStreamErrorCode_RTMP_BadParams - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_ForbiddenByRegion - rtmp URL 中的推流不在发布点内（KSY 自定义） - KSYStreamErrorCode_RTMP_ForbiddenByRegion - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_FRAMES_THRESHOLD - (obsolete) - KSYStreamErrorCode_FRAMES_THRESHOLD - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_NO_INPUT_SAMPLE - (obsolete) - KSYStreamErrorCode_NO_INPUT_SAMPLE - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_DNS_Parse_failed - 对于URL中的域名解析失败 - KSYStreamErrorCode_DNS_Parse_failed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_Connect_Server_failed - 对于URL对应的服务器连接失败(无法建立TCP连接) - KSYStreamErrorCode_Connect_Server_failed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_Publish_failed - 跟RTMP服务器完成握手后,向{appname}/{streamname} 推流失败 - KSYStreamErrorCode_RTMP_Publish_failed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_AV_SYNC_ERROR - 音视频同步失败 (输入的音频和视频的时间戳的差值超过5s) - KSYStreamErrorCode_AV_SYNC_ERROR - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_INVALID_ADDRESS - 非法地址(地址为空或url中的协议或本地文件的后缀SDK不支持, 请检查) - KSYStreamErrorCode_INVALID_ADDRESS - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_NETWORK_UNREACHABLE - 网络不通 - KSYStreamErrorCode_NETWORK_UNREACHABLE - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_GetUserIdFailed - 获取user id失败 (KSY 自定义) - KSYStreamErrorCode_RTMP_GetUserIdFailed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_AkAndUserIsNotMatch - AK和user id不匹配 (KSY 自定义) - KSYStreamErrorCode_RTMP_AkAndUserIsNotMatch - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_GetServerInfoFailed - 获取服务器信息失败 (KSY 自定义) - KSYStreamErrorCode_RTMP_GetServerInfoFailed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_IllegalOutsideUrl - 非法的外部url (KSY 自定义) - KSYStreamErrorCode_RTMP_IllegalOutsideUrl - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_OutsideAuthFailed - 外部鉴权失败 (KSY 自定义) - KSYStreamErrorCode_RTMP_OutsideAuthFailed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_SimpleAuthFailed - 简单鉴权失败(KSY 自定义) - KSYStreamErrorCode_RTMP_SimpleAuthFailed - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InvalidAuthType - 无效的鉴权类型 (KSY 自定义) - KSYStreamErrorCode_RTMP_InvalidAuthType - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamErrorCode_RTMP_IllegalUserId - 非法的user id (KSY 自定义) - KSYStreamErrorCode_RTMP_IllegalUserId + //apple_ref/c/econst/KSYRecordErrorInternal + 内部错误 + KSYRecordErrorInternal KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens69.xml b/doc/docset/Contents/Resources/Tokens69.xml index 9d93206..89d0bf8 100644 --- a/doc/docset/Contents/Resources/Tokens69.xml +++ b/doc/docset/Contents/Resources/Tokens69.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYStreamState - 推流状态 + //apple_ref/c/tdef/KSYRecordState + 旁路录制状态 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYStreamStateIdle - 初始化时状态为空闲 - KSYStreamStateIdle + //apple_ref/c/econst/KSYRecordStateIdle + 初始状态 + KSYRecordStateIdle KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYStreamStateConnecting - 连接中 - KSYStreamStateConnecting + //apple_ref/c/econst/KSYRecordStateRecording + 录像中 + KSYRecordStateRecording KSYTypeDef.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/KSYStreamStateConnected - 已连接 - KSYStreamStateConnected + //apple_ref/c/econst/KSYRecordStateStopped + 录像停止 + KSYRecordStateStopped KSYTypeDef.h @@ -44,19 +44,9 @@ - //apple_ref/c/econst/KSYStreamStateDisconnecting - 断开连接中 - KSYStreamStateDisconnecting - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYStreamStateError - 推流出错 - KSYStreamStateError + //apple_ref/c/econst/KSYRecordStateError + 录像失败 + KSYRecordStateError KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens70.xml b/doc/docset/Contents/Resources/Tokens70.xml index e8c6498..afb9f05 100644 --- a/doc/docset/Contents/Resources/Tokens70.xml +++ b/doc/docset/Contents/Resources/Tokens70.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYTranscodeErrorCode - 转码错误码，用于说明转码失败的原因 - KSYTranscoder.h + //apple_ref/c/tdef/KSYStreamErrorCode + 推流错误码，用于指示推流失败的原因 + KSYTypeDef.h @@ -14,91 +14,361 @@ - //apple_ref/c/econst/KSYTranscodeErrorCode_None + //apple_ref/c/econst/KSYStreamErrorCode_NONE 正常无错误 - KSYTranscodeErrorCode_None + KSYStreamErrorCode_NONE - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_InvalidAddress - 无效的文件地址(输入或输出地址为空) - KSYTranscodeErrorCode_InvalidAddress + //apple_ref/c/econst/KSYStreamErrorCode_KSYAUTHFAILED + (obsolete) + KSYStreamErrorCode_KSYAUTHFAILED - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_InputFile_OpenFailed - 打开输入文件失败 - KSYTranscodeErrorCode_InputFile_OpenFailed + //apple_ref/c/econst/__deprecated_enum_msg + + __deprecated_enum_msg - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_InvalidData - 无效的媒体数据 - KSYTranscodeErrorCode_InvalidData + //apple_ref/c/econst/( + + ( - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_UnsupportedFormat - 不支持的输出文件格式 - KSYTranscodeErrorCode_OutputFile_UnsupportedFormat + //apple_ref/c/econst/"auth removed" + + "auth removed" - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_OpenFailed - 打开输出文件失败 - KSYTranscodeErrorCode_OutputFile_OpenFailed + //apple_ref/c/econst/) + + ) - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_AddStreamFailed - 输出文件添加流失败 - KSYTranscodeErrorCode_OutputFile_AddStreamFailed + //apple_ref/c/econst/KSYStreamErrorCode_ENCODE_FRAMES_FAILED + 当前帧编码失败 + KSYStreamErrorCode_ENCODE_FRAMES_FAILED - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_StartWriteFailed - 输出文件头写入失败(通常为不支持的codec) - KSYTranscodeErrorCode_OutputFile_StartWriteFailed + //apple_ref/c/econst/KSYStreamErrorCode_CODEC_OPEN_FAILED + 无法打开配置指示的CODEC + KSYStreamErrorCode_CODEC_OPEN_FAILED - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeErrorCode_Transcoding_Failed - 转码过程中出现错误 - KSYTranscodeErrorCode_Transcoding_Failed + //apple_ref/c/econst/KSYStreamErrorCode_CONNECT_FAILED + 连接出错，检查地址 + KSYStreamErrorCode_CONNECT_FAILED - KSYTranscoder.h + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_CONNECT_BREAK + 网络连接中断 + KSYStreamErrorCode_CONNECT_BREAK + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_NonExistDomain + rtmp 推流域名不存在 (KSY 自定义) + KSYStreamErrorCode_RTMP_NonExistDomain + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_NonExistApplication + rtmp 应用名不存在(KSY 自定义) + KSYStreamErrorCode_RTMP_NonExistApplication + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_AlreadyExistStreamName + rtmp 流名已存在(KSY 自定义) + KSYStreamErrorCode_RTMP_AlreadyExistStreamName + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_ForbiddenByBlacklist + rtmp 被黑名单拒绝(KSY 自定义) + KSYStreamErrorCode_RTMP_ForbiddenByBlacklist + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InternalError + rtmp 内部错误(KSY 自定义) + KSYStreamErrorCode_RTMP_InternalError + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_URLExpired + rtmp URL 地址已过期(KSY 自定义) + KSYStreamErrorCode_RTMP_URLExpired + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_SignatureDoesNotMatch + rtmp URL 地址签名错误(KSY 自定义) + KSYStreamErrorCode_RTMP_SignatureDoesNotMatch + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InvalidAccessKeyId + rtmp URL 中AccessKeyId非法(KSY 自定义) + KSYStreamErrorCode_RTMP_InvalidAccessKeyId + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_BadParams + rtmp URL 中参数错误(KSY 自定义) + KSYStreamErrorCode_RTMP_BadParams + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_ForbiddenByRegion + rtmp URL 中的推流不在发布点内（KSY 自定义） + KSYStreamErrorCode_RTMP_ForbiddenByRegion + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_FRAMES_THRESHOLD + (obsolete) + KSYStreamErrorCode_FRAMES_THRESHOLD + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_NO_INPUT_SAMPLE + (obsolete) + KSYStreamErrorCode_NO_INPUT_SAMPLE + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_DNS_Parse_failed + 对于URL中的域名解析失败 + KSYStreamErrorCode_DNS_Parse_failed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_Connect_Server_failed + 对于URL对应的服务器连接失败(无法建立TCP连接) + KSYStreamErrorCode_Connect_Server_failed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_Publish_failed + 跟RTMP服务器完成握手后,向{appname}/{streamname} 推流失败 + KSYStreamErrorCode_RTMP_Publish_failed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_AV_SYNC_ERROR + 音视频同步失败 (输入的音频和视频的时间戳的差值超过5s) + KSYStreamErrorCode_AV_SYNC_ERROR + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_INVALID_ADDRESS + 非法地址(地址为空或url中的协议或本地文件的后缀SDK不支持, 请检查) + KSYStreamErrorCode_INVALID_ADDRESS + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_NETWORK_UNREACHABLE + 网络不通 + KSYStreamErrorCode_NETWORK_UNREACHABLE + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_GetUserIdFailed + 获取user id失败 (KSY 自定义) + KSYStreamErrorCode_RTMP_GetUserIdFailed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_AkAndUserIsNotMatch + AK和user id不匹配 (KSY 自定义) + KSYStreamErrorCode_RTMP_AkAndUserIsNotMatch + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_GetServerInfoFailed + 获取服务器信息失败 (KSY 自定义) + KSYStreamErrorCode_RTMP_GetServerInfoFailed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_IllegalOutsideUrl + 非法的外部url (KSY 自定义) + KSYStreamErrorCode_RTMP_IllegalOutsideUrl + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_OutsideAuthFailed + 外部鉴权失败 (KSY 自定义) + KSYStreamErrorCode_RTMP_OutsideAuthFailed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_SimpleAuthFailed + 简单鉴权失败(KSY 自定义) + KSYStreamErrorCode_RTMP_SimpleAuthFailed + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_InvalidAuthType + 无效的鉴权类型 (KSY 自定义) + KSYStreamErrorCode_RTMP_InvalidAuthType + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamErrorCode_RTMP_IllegalUserId + 非法的user id (KSY 自定义) + KSYStreamErrorCode_RTMP_IllegalUserId + + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens71.xml b/doc/docset/Contents/Resources/Tokens71.xml index 11ebc92..4dc898d 100644 --- a/doc/docset/Contents/Resources/Tokens71.xml +++ b/doc/docset/Contents/Resources/Tokens71.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYTranscodeState - 转码状态 - KSYTranscoder.h + //apple_ref/c/tdef/KSYStreamState + 推流状态 + KSYTypeDef.h @@ -14,41 +14,51 @@ - //apple_ref/c/econst/KSYTranscodeState_Idle - 初始状态 - KSYTranscodeState_Idle + //apple_ref/c/econst/KSYStreamStateIdle + 初始化时状态为空闲 + KSYStreamStateIdle - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeState_Transcoding - 转码中 - KSYTranscodeState_Transcoding + //apple_ref/c/econst/KSYStreamStateConnecting + 连接中 + KSYStreamStateConnecting - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeState_Completed - 转码完成 - KSYTranscodeState_Completed + //apple_ref/c/econst/KSYStreamStateConnected + 已连接 + KSYStreamStateConnected - KSYTranscoder.h + KSYTypeDef.h - //apple_ref/c/econst/KSYTranscodeState_Error - 转码失败 - KSYTranscodeState_Error + //apple_ref/c/econst/KSYStreamStateDisconnecting + 断开连接中 + KSYStreamStateDisconnecting - KSYTranscoder.h + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYStreamStateError + 推流出错 + KSYStreamStateError + + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens72.xml b/doc/docset/Contents/Resources/Tokens72.xml index 082d182..c277931 100644 --- a/doc/docset/Contents/Resources/Tokens72.xml +++ b/doc/docset/Contents/Resources/Tokens72.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYVideoCodec - 视频编码器类型 - KSYTypeDef.h + //apple_ref/c/tdef/KSYTranscodeErrorCode + 转码错误码，用于说明转码失败的原因 + KSYTranscoder.h @@ -14,51 +14,91 @@ - //apple_ref/c/econst/KSYVideoCodec_X264 - 视频编码器 - h264 软件编码器 - KSYVideoCodec_X264 + //apple_ref/c/econst/KSYTranscodeErrorCode_None + 正常无错误 + KSYTranscodeErrorCode_None - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoCodec_QY265 - 视频编码器 - KSY265 软件编码器 - KSYVideoCodec_QY265 + //apple_ref/c/econst/KSYTranscodeErrorCode_InvalidAddress + 无效的文件地址(输入或输出地址为空) + KSYTranscodeErrorCode_InvalidAddress - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoCodec_VT264 - 视频编码器 - iOS VT264硬件编码器 (iOS 8.0以上支持) - KSYVideoCodec_VT264 + //apple_ref/c/econst/KSYTranscodeErrorCode_InputFile_OpenFailed + 打开输入文件失败 + KSYTranscodeErrorCode_InputFile_OpenFailed - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoCodec_AUTO - 视频编码器 - 由SDK自动选择（ VT264 > X264） - KSYVideoCodec_AUTO + //apple_ref/c/econst/KSYTranscodeErrorCode_InvalidData + 无效的媒体数据 + KSYTranscodeErrorCode_InvalidData - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoCodec_GIF - 视频编码器 - gif - KSYVideoCodec_GIF + //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_UnsupportedFormat + 不支持的输出文件格式 + KSYTranscodeErrorCode_OutputFile_UnsupportedFormat - KSYTypeDef.h + KSYTranscoder.h + + + + + + //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_OpenFailed + 打开输出文件失败 + KSYTranscodeErrorCode_OutputFile_OpenFailed + + KSYTranscoder.h + + + + + + //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_AddStreamFailed + 输出文件添加流失败 + KSYTranscodeErrorCode_OutputFile_AddStreamFailed + + KSYTranscoder.h + + + + + + //apple_ref/c/econst/KSYTranscodeErrorCode_OutputFile_StartWriteFailed + 输出文件头写入失败(通常为不支持的codec) + KSYTranscodeErrorCode_OutputFile_StartWriteFailed + + KSYTranscoder.h + + + + + + //apple_ref/c/econst/KSYTranscodeErrorCode_Transcoding_Failed + 转码过程中出现错误 + KSYTranscodeErrorCode_Transcoding_Failed + + KSYTranscoder.h diff --git a/doc/docset/Contents/Resources/Tokens73.xml b/doc/docset/Contents/Resources/Tokens73.xml index d217e85..90367ae 100644 --- a/doc/docset/Contents/Resources/Tokens73.xml +++ b/doc/docset/Contents/Resources/Tokens73.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSYVideoDimension - 采集分辨率 - KSYTypeDef.h + //apple_ref/c/tdef/KSYTranscodeState + 转码状态 + KSYTranscoder.h @@ -14,81 +14,41 @@ - //apple_ref/c/econst/KSYVideoDimension_16_9__1280x720 - 16 : 9 宽高比，1280 x 720 分辨率 - KSYVideoDimension_16_9__1280x720 + //apple_ref/c/econst/KSYTranscodeState_Idle + 初始状态 + KSYTranscodeState_Idle - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoDimension_16_9__960x540 - 16 : 9 宽高比，960 x 540 分辨率 - KSYVideoDimension_16_9__960x540 + //apple_ref/c/econst/KSYTranscodeState_Transcoding + 转码中 + KSYTranscodeState_Transcoding - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoDimension_4_3__640x480 - 4 : 3 宽高比，640 x 480 分辨率 - KSYVideoDimension_4_3__640x480 + //apple_ref/c/econst/KSYTranscodeState_Completed + 转码完成 + KSYTranscodeState_Completed - KSYTypeDef.h + KSYTranscoder.h - //apple_ref/c/econst/KSYVideoDimension_16_9__640x360 - 16 : 9 宽高比，640 x 360 分辨率 - KSYVideoDimension_16_9__640x360 + //apple_ref/c/econst/KSYTranscodeState_Error + 转码失败 + KSYTranscodeState_Error - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYVideoDimension_5_4__352x288 - 4 : 3 宽高比，320 x 240 分辨率 - KSYVideoDimension_5_4__352x288 - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYVideoDimension_UserDefine_Scale - 缩放自定义分辨率 从设备支持的最近分辨率缩放获得, 若设备没有对应宽高比的分辨率，则裁剪后进行缩放 - KSYVideoDimension_UserDefine_Scale - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYVideoDimension_UserDefine_Crop - 裁剪自定义分辨率 从设备支持的最近分辨率裁剪获得 - KSYVideoDimension_UserDefine_Crop - - KSYTypeDef.h - - - - - - //apple_ref/c/econst/KSYVideoDimension_Default - 默认分辨率，默认为 4 : 3 宽高比，640 x 480 分辨率 - KSYVideoDimension_Default - - KSYTypeDef.h + KSYTranscoder.h diff --git a/doc/docset/Contents/Resources/Tokens74.xml b/doc/docset/Contents/Resources/Tokens74.xml index df62290..a132ef7 100644 --- a/doc/docset/Contents/Resources/Tokens74.xml +++ b/doc/docset/Contents/Resources/Tokens74.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/KSYVideoEncodePerformance - 视频编码性能档次 (视频质量 和 设备资源之间的权衡) + //apple_ref/c/tdef/KSYVideoCodec + 视频编码器类型 KSYTypeDef.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/KSYVideoEncodePer_LowPower - 低功耗: cpu资源消耗低一些,视频质量差一些 - KSYVideoEncodePer_LowPower + //apple_ref/c/econst/KSYVideoCodec_X264 + 视频编码器 - h264 软件编码器 + KSYVideoCodec_X264 KSYTypeDef.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/KSYVideoEncodePer_Balance - 均衡档次: 性价比比较高 - KSYVideoEncodePer_Balance + //apple_ref/c/econst/KSYVideoCodec_QY265 + 视频编码器 - KSY265 软件编码器 + KSYVideoCodec_QY265 KSYTypeDef.h @@ -34,9 +34,39 @@ - //apple_ref/c/econst/KSYVideoEncodePer_HighPerformance - 高性能: 画面质量高 - KSYVideoEncodePer_HighPerformance + //apple_ref/c/econst/KSYVideoCodec_VT264 + 视频编码器 - iOS VT264硬件编码器 (iOS 8.0以上支持) + KSYVideoCodec_VT264 + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoCodec_VT265 + 视频编码器 - iOS VT265硬件编码器 (iOS 11.0 以上) + KSYVideoCodec_VT265 + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoCodec_AUTO + 视频编码器 - 由SDK自动选择（ VT264 > X264） + KSYVideoCodec_AUTO + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoCodec_GIF + 视频编码器 - gif + KSYVideoCodec_GIF KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens75.xml b/doc/docset/Contents/Resources/Tokens75.xml index a9e3c7b..1f96e78 100644 --- a/doc/docset/Contents/Resources/Tokens75.xml +++ b/doc/docset/Contents/Resources/Tokens75.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/KSY_NETTRACKER_ACTION - 探测方式 - KSYNetTracker.h + //apple_ref/c/tdef/KSYVideoDimension + 采集分辨率 + KSYTypeDef.h @@ -14,21 +14,81 @@ - //apple_ref/c/econst/KSY_NETTRACKER_ACTION_MTR - mtr方式，探测链路上每个节点 - KSY_NETTRACKER_ACTION_MTR + //apple_ref/c/econst/KSYVideoDimension_16_9__1280x720 + 16 : 9 宽高比，1280 x 720 分辨率 + KSYVideoDimension_16_9__1280x720 - KSYNetTracker.h + KSYTypeDef.h - //apple_ref/c/econst/KSY_NETTRACKER_ACTION_PING - ping方式，直接探测终点 - KSY_NETTRACKER_ACTION_PING + //apple_ref/c/econst/KSYVideoDimension_16_9__960x540 + 16 : 9 宽高比，960 x 540 分辨率 + KSYVideoDimension_16_9__960x540 - KSYNetTracker.h + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_4_3__640x480 + 4 : 3 宽高比，640 x 480 分辨率 + KSYVideoDimension_4_3__640x480 + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_16_9__640x360 + 16 : 9 宽高比，640 x 360 分辨率 + KSYVideoDimension_16_9__640x360 + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_5_4__352x288 + 4 : 3 宽高比，320 x 240 分辨率 + KSYVideoDimension_5_4__352x288 + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_UserDefine_Scale + 缩放自定义分辨率 从设备支持的最近分辨率缩放获得, 若设备没有对应宽高比的分辨率，则裁剪后进行缩放 + KSYVideoDimension_UserDefine_Scale + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_UserDefine_Crop + 裁剪自定义分辨率 从设备支持的最近分辨率裁剪获得 + KSYVideoDimension_UserDefine_Crop + + KSYTypeDef.h + + + + + + //apple_ref/c/econst/KSYVideoDimension_Default + 默认分辨率，默认为 4 : 3 宽高比，640 x 480 分辨率 + KSYVideoDimension_Default + + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens76.xml b/doc/docset/Contents/Resources/Tokens76.xml index 397766a..87eb60b 100644 --- a/doc/docset/Contents/Resources/Tokens76.xml +++ b/doc/docset/Contents/Resources/Tokens76.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/MEDIAINFO_CODEC_ID - 音视频格式 - KSYMediaInfo.h + //apple_ref/c/tdef/KSYVideoEncodePerformance + 视频编码性能档次 (视频质量 和 设备资源之间的权衡) + KSYTypeDef.h @@ -14,151 +14,31 @@ - //apple_ref/c/econst/MEDIAINFO_CODEC_ID_UNKNOWN - 未知的音视频编码格式 - MEDIAINFO_CODEC_ID_UNKNOWN + //apple_ref/c/econst/KSYVideoEncodePer_LowPower + 低功耗: cpu资源消耗低一些,视频质量差一些 + KSYVideoEncodePer_LowPower - KSYMediaInfo.h + KSYTypeDef.h - //apple_ref/c/econst/MEDIAINFO_CODEC_MPEG2VIDEO - 视频编码格式MPEG2 - MEDIAINFO_CODEC_MPEG2VIDEO + //apple_ref/c/econst/KSYVideoEncodePer_Balance + 均衡档次: 性价比比较高 + KSYVideoEncodePer_Balance - KSYMediaInfo.h + KSYTypeDef.h - //apple_ref/c/econst/MEDIAINFO_CODEC_MPEG4 - 视频编码格式MPEG4 - MEDIAINFO_CODEC_MPEG4 + //apple_ref/c/econst/KSYVideoEncodePer_HighPerformance + 高性能: 画面质量高 + KSYVideoEncodePer_HighPerformance - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_MJPEG - 视频编码格式MJPEG - MEDIAINFO_CODEC_MJPEG - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_JPEG2000 - 视频编码格式JPEG2000 - MEDIAINFO_CODEC_JPEG2000 - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_H264 - 视频编码格式H264 - MEDIAINFO_CODEC_H264 - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_HEVC - 视频编码格式HEVC - MEDIAINFO_CODEC_HEVC - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_VC1 - 视频编码格式VC1 - MEDIAINFO_CODEC_VC1 - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_ID_FIRST_AUDIO - 首个音频编码格式定义(不对应具体的编码格式) - MEDIAINFO_CODEC_ID_FIRST_AUDIO - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_AAC - 音频编码格式AAC - MEDIAINFO_CODEC_AAC - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_AC3 - 音频编码格式AC3 - MEDIAINFO_CODEC_AC3 - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_MP3 - 音频编码格式MP3 - MEDIAINFO_CODEC_MP3 - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_PCM - 音频编码格式PCM - MEDIAINFO_CODEC_PCM - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_DTS - 音频编码格式DTS - MEDIAINFO_CODEC_DTS - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_CODEC_NELLYMOSER - 音频编码格式NELLYMOSER - MEDIAINFO_CODEC_NELLYMOSER - - KSYMediaInfo.h + KSYTypeDef.h diff --git a/doc/docset/Contents/Resources/Tokens77.xml b/doc/docset/Contents/Resources/Tokens77.xml index 3fcef8e..7947670 100644 --- a/doc/docset/Contents/Resources/Tokens77.xml +++ b/doc/docset/Contents/Resources/Tokens77.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/MEDIAINFO_MUX_TYPE - 封装格式 - KSYMediaInfo.h + //apple_ref/c/tdef/KSY_NETTRACKER_ACTION + 探测方式 + KSYNetTracker.h @@ -14,131 +14,21 @@ - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_UNKNOWN - 未知的文件封装格式 - MEDIAINFO_MUXTYPE_UNKNOWN + //apple_ref/c/econst/KSY_NETTRACKER_ACTION_MTR + mtr方式，探测链路上每个节点 + KSY_NETTRACKER_ACTION_MTR - KSYMediaInfo.h + KSYNetTracker.h - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MP2T - 封装格式为TS - MEDIAINFO_MUXTYPE_MP2T + //apple_ref/c/econst/KSY_NETTRACKER_ACTION_PING + ping方式，直接探测终点 + KSY_NETTRACKER_ACTION_PING - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MOV - 封装格式为MOV - MEDIAINFO_MUXTYPE_MOV - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_AVI - 封装格式为AVI - MEDIAINFO_MUXTYPE_AVI - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_FLV - 封装格式为FLV - MEDIAINFO_MUXTYPE_FLV - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MKV - 封装格式为MKV - MEDIAINFO_MUXTYPE_MKV - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_ASF - 封装格式为ASF - MEDIAINFO_MUXTYPE_ASF - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_RM - 封装格式为RM - MEDIAINFO_MUXTYPE_RM - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_WAV - 封装格式为WAV - MEDIAINFO_MUXTYPE_WAV - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_OGG - 封装格式为OGG - MEDIAINFO_MUXTYPE_OGG - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_APE - 封装格式为APE - MEDIAINFO_MUXTYPE_APE - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_RAWVIDEO - 封装格式为RAWVIDEO - MEDIAINFO_MUXTYPE_RAWVIDEO - - KSYMediaInfo.h - - - - - - //apple_ref/c/econst/MEDIAINFO_MUXTYPE_HLS - 封装格式为HLS - MEDIAINFO_MUXTYPE_HLS - - KSYMediaInfo.h + KSYNetTracker.h diff --git a/doc/docset/Contents/Resources/Tokens78.xml b/doc/docset/Contents/Resources/Tokens78.xml index 5cba7b4..3333739 100644 --- a/doc/docset/Contents/Resources/Tokens78.xml +++ b/doc/docset/Contents/Resources/Tokens78.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/MEDIAINFO_SAMPLE_FMT - 音频采样格式 + //apple_ref/c/tdef/MEDIAINFO_CODEC_ID + 音视频格式 KSYMediaInfo.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_UNKNOWN - 未知的音频采样格式 - MEDIAINFO_SAMPLE_FMT_UNKNOWN + //apple_ref/c/econst/MEDIAINFO_CODEC_ID_UNKNOWN + 未知的音视频编码格式 + MEDIAINFO_CODEC_ID_UNKNOWN KSYMediaInfo.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_U8 - 音频采样格式为unsigned 8 bits - MEDIAINFO_SAMPLE_FMT_U8 + //apple_ref/c/econst/MEDIAINFO_CODEC_MPEG2VIDEO + 视频编码格式MPEG2 + MEDIAINFO_CODEC_MPEG2VIDEO KSYMediaInfo.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S16 - 音频采样格式为signed 16 bits - MEDIAINFO_SAMPLE_FMT_S16 + //apple_ref/c/econst/MEDIAINFO_CODEC_MPEG4 + 视频编码格式MPEG4 + MEDIAINFO_CODEC_MPEG4 KSYMediaInfo.h @@ -44,9 +44,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S32 - 音频采样格式为signed 32 bits - MEDIAINFO_SAMPLE_FMT_S32 + //apple_ref/c/econst/MEDIAINFO_CODEC_MJPEG + 视频编码格式MJPEG + MEDIAINFO_CODEC_MJPEG KSYMediaInfo.h @@ -54,9 +54,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_FLT - 音频采样格式为float - MEDIAINFO_SAMPLE_FMT_FLT + //apple_ref/c/econst/MEDIAINFO_CODEC_JPEG2000 + 视频编码格式JPEG2000 + MEDIAINFO_CODEC_JPEG2000 KSYMediaInfo.h @@ -64,9 +64,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_DBL - 音频采样格式为double - MEDIAINFO_SAMPLE_FMT_DBL + //apple_ref/c/econst/MEDIAINFO_CODEC_H264 + 视频编码格式H264 + MEDIAINFO_CODEC_H264 KSYMediaInfo.h @@ -74,9 +74,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_U8P - 音频采样格式为unsigned 8 bits, planar - MEDIAINFO_SAMPLE_FMT_U8P + //apple_ref/c/econst/MEDIAINFO_CODEC_HEVC + 视频编码格式HEVC + MEDIAINFO_CODEC_HEVC KSYMediaInfo.h @@ -84,9 +84,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S16P - 音频采样格式为signed 16 bits, planar - MEDIAINFO_SAMPLE_FMT_S16P + //apple_ref/c/econst/MEDIAINFO_CODEC_VC1 + 视频编码格式VC1 + MEDIAINFO_CODEC_VC1 KSYMediaInfo.h @@ -94,9 +94,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S32P - 音频采样格式为signed 32 bits, planar - MEDIAINFO_SAMPLE_FMT_S32P + //apple_ref/c/econst/MEDIAINFO_CODEC_ID_FIRST_AUDIO + 首个音频编码格式定义(不对应具体的编码格式) + MEDIAINFO_CODEC_ID_FIRST_AUDIO KSYMediaInfo.h @@ -104,9 +104,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_FLTP - 音频采样格式为float, planar - MEDIAINFO_SAMPLE_FMT_FLTP + //apple_ref/c/econst/MEDIAINFO_CODEC_AAC + 音频编码格式AAC + MEDIAINFO_CODEC_AAC KSYMediaInfo.h @@ -114,9 +114,9 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_DBLP - 音频采样格式为double, planar - MEDIAINFO_SAMPLE_FMT_DBLP + //apple_ref/c/econst/MEDIAINFO_CODEC_AC3 + 音频编码格式AC3 + MEDIAINFO_CODEC_AC3 KSYMediaInfo.h @@ -124,9 +124,39 @@ - //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_NB - 音频采样格式为Number of sample formats - MEDIAINFO_SAMPLE_FMT_NB + //apple_ref/c/econst/MEDIAINFO_CODEC_MP3 + 音频编码格式MP3 + MEDIAINFO_CODEC_MP3 + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_CODEC_PCM + 音频编码格式PCM + MEDIAINFO_CODEC_PCM + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_CODEC_DTS + 音频编码格式DTS + MEDIAINFO_CODEC_DTS + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_CODEC_NELLYMOSER + 音频编码格式NELLYMOSER + MEDIAINFO_CODEC_NELLYMOSER KSYMediaInfo.h diff --git a/doc/docset/Contents/Resources/Tokens79.xml b/doc/docset/Contents/Resources/Tokens79.xml index deb2405..aa17022 100644 --- a/doc/docset/Contents/Resources/Tokens79.xml +++ b/doc/docset/Contents/Resources/Tokens79.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/MPMovieAudioPan - 立体声平衡 - KSYMoviePlayerDefines.h + //apple_ref/c/tdef/MEDIAINFO_MUX_TYPE + 封装格式 + KSYMediaInfo.h @@ -14,31 +14,131 @@ - //apple_ref/c/econst/MPMovieAudioPan_Left - 完全左声道 - MPMovieAudioPan_Left + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_UNKNOWN + 未知的文件封装格式 + MEDIAINFO_MUXTYPE_UNKNOWN - KSYMoviePlayerDefines.h + KSYMediaInfo.h - //apple_ref/c/econst/MPMovieAudioPan_Stereo - 左右声道平衡 - MPMovieAudioPan_Stereo + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MP2T + 封装格式为TS + MEDIAINFO_MUXTYPE_MP2T - KSYMoviePlayerDefines.h + KSYMediaInfo.h - //apple_ref/c/econst/MPMovieAudioPan_Right - 完全右声道 - MPMovieAudioPan_Right + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MOV + 封装格式为MOV + MEDIAINFO_MUXTYPE_MOV - KSYMoviePlayerDefines.h + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_AVI + 封装格式为AVI + MEDIAINFO_MUXTYPE_AVI + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_FLV + 封装格式为FLV + MEDIAINFO_MUXTYPE_FLV + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_MKV + 封装格式为MKV + MEDIAINFO_MUXTYPE_MKV + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_ASF + 封装格式为ASF + MEDIAINFO_MUXTYPE_ASF + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_RM + 封装格式为RM + MEDIAINFO_MUXTYPE_RM + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_WAV + 封装格式为WAV + MEDIAINFO_MUXTYPE_WAV + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_OGG + 封装格式为OGG + MEDIAINFO_MUXTYPE_OGG + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_APE + 封装格式为APE + MEDIAINFO_MUXTYPE_APE + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_RAWVIDEO + 封装格式为RAWVIDEO + MEDIAINFO_MUXTYPE_RAWVIDEO + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_MUXTYPE_HLS + 封装格式为HLS + MEDIAINFO_MUXTYPE_HLS + + KSYMediaInfo.h diff --git a/doc/docset/Contents/Resources/Tokens80.xml b/doc/docset/Contents/Resources/Tokens80.xml index c8b5231..50dffcb 100644 --- a/doc/docset/Contents/Resources/Tokens80.xml +++ b/doc/docset/Contents/Resources/Tokens80.xml @@ -1,11 +1,11 @@ - + - //apple_ref/c/tdef/MPMovieMetaType - Meta类型 - KSYMoviePlayerDefines.h + //apple_ref/c/tdef/MEDIAINFO_SAMPLE_FMT + 音频采样格式 + KSYMediaInfo.h @@ -14,41 +14,121 @@ - //apple_ref/c/econst/MPMovieMetaType_Media - 当前播放文件的Meta - MPMovieMetaType_Media + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_UNKNOWN + 未知的音频采样格式 + MEDIAINFO_SAMPLE_FMT_UNKNOWN - KSYMoviePlayerDefines.h + KSYMediaInfo.h - //apple_ref/c/econst/MPMovieMetaType_Video - 当前播放的视频Meta - MPMovieMetaType_Video + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_U8 + 音频采样格式为unsigned 8 bits + MEDIAINFO_SAMPLE_FMT_U8 - KSYMoviePlayerDefines.h + KSYMediaInfo.h - //apple_ref/c/econst/MPMovieMetaType_Audio - 当前播放的音频Meta - MPMovieMetaType_Audio + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S16 + 音频采样格式为signed 16 bits + MEDIAINFO_SAMPLE_FMT_S16 - KSYMoviePlayerDefines.h + KSYMediaInfo.h - //apple_ref/c/econst/MPMovieMetaType_Subtitle - 当前播放的字幕Meta - MPMovieMetaType_Subtitle + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S32 + 音频采样格式为signed 32 bits + MEDIAINFO_SAMPLE_FMT_S32 - KSYMoviePlayerDefines.h + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_FLT + 音频采样格式为float + MEDIAINFO_SAMPLE_FMT_FLT + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_DBL + 音频采样格式为double + MEDIAINFO_SAMPLE_FMT_DBL + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_U8P + 音频采样格式为unsigned 8 bits, planar + MEDIAINFO_SAMPLE_FMT_U8P + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S16P + 音频采样格式为signed 16 bits, planar + MEDIAINFO_SAMPLE_FMT_S16P + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_S32P + 音频采样格式为signed 32 bits, planar + MEDIAINFO_SAMPLE_FMT_S32P + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_FLTP + 音频采样格式为float, planar + MEDIAINFO_SAMPLE_FMT_FLTP + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_DBLP + 音频采样格式为double, planar + MEDIAINFO_SAMPLE_FMT_DBLP + + KSYMediaInfo.h + + + + + + //apple_ref/c/econst/MEDIAINFO_SAMPLE_FMT_NB + 音频采样格式为Number of sample formats + MEDIAINFO_SAMPLE_FMT_NB + + KSYMediaInfo.h diff --git a/doc/docset/Contents/Resources/Tokens81.xml b/doc/docset/Contents/Resources/Tokens81.xml index e515235..6f1d7a5 100644 --- a/doc/docset/Contents/Resources/Tokens81.xml +++ b/doc/docset/Contents/Resources/Tokens81.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/MPMovieReloadMode - reload模式 + //apple_ref/c/tdef/MPMovieAudioPan + 立体声平衡 KSYMoviePlayerDefines.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/MPMovieReloadMode_Fast - 加速播放模式 - MPMovieReloadMode_Fast + //apple_ref/c/econst/MPMovieAudioPan_Left + 完全左声道 + MPMovieAudioPan_Left KSYMoviePlayerDefines.h @@ -24,9 +24,19 @@ - //apple_ref/c/econst/MPMovieReloadMode_Accurate - 精确检测模式 - MPMovieReloadMode_Accurate + //apple_ref/c/econst/MPMovieAudioPan_Stereo + 左右声道平衡 + MPMovieAudioPan_Stereo + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieAudioPan_Right + 完全右声道 + MPMovieAudioPan_Right KSYMoviePlayerDefines.h diff --git a/doc/docset/Contents/Resources/Tokens82.xml b/doc/docset/Contents/Resources/Tokens82.xml index c2a061a..775350a 100644 --- a/doc/docset/Contents/Resources/Tokens82.xml +++ b/doc/docset/Contents/Resources/Tokens82.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/MPMovieStatus - status类型 + //apple_ref/c/tdef/MPMovieMetaType + Meta类型 KSYMoviePlayerDefines.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/MPMovieStatusVideoDecodeWrong - 视频解码出错 - MPMovieStatusVideoDecodeWrong + //apple_ref/c/econst/MPMovieMetaType_Media + 当前播放文件的Meta + MPMovieMetaType_Media KSYMoviePlayerDefines.h @@ -24,9 +24,9 @@ - //apple_ref/c/econst/MPMovieStatusAudioDecodeWrong - 音频解码出错 - MPMovieStatusAudioDecodeWrong + //apple_ref/c/econst/MPMovieMetaType_Video + 当前播放的视频Meta + MPMovieMetaType_Video KSYMoviePlayerDefines.h @@ -34,9 +34,9 @@ - //apple_ref/c/econst/MPMovieStatusHWCodecUsed - 使用硬件解码 - MPMovieStatusHWCodecUsed + //apple_ref/c/econst/MPMovieMetaType_Audio + 当前播放的音频Meta + MPMovieMetaType_Audio KSYMoviePlayerDefines.h @@ -44,19 +44,9 @@ - //apple_ref/c/econst/MPMovieStatusSWCodecUsed - 使用软件解码 - MPMovieStatusSWCodecUsed - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/MPMovieStatusDLCodecUsed - 使用AVSampleBufferDisplayLayer解码渲染 - MPMovieStatusDLCodecUsed + //apple_ref/c/econst/MPMovieMetaType_Subtitle + 当前播放的字幕Meta + MPMovieMetaType_Subtitle KSYMoviePlayerDefines.h diff --git a/doc/docset/Contents/Resources/Tokens83.xml b/doc/docset/Contents/Resources/Tokens83.xml index 1299360..1cbba5c 100644 --- a/doc/docset/Contents/Resources/Tokens83.xml +++ b/doc/docset/Contents/Resources/Tokens83.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/MPMovieVideoDecoderMode - 视频解码模式 + //apple_ref/c/tdef/MPMovieReloadMode + reload模式 KSYMoviePlayerDefines.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/MPMovieVideoDecoderMode_Software - 视频解码方式采用软解 - MPMovieVideoDecoderMode_Software + //apple_ref/c/econst/MPMovieReloadMode_Fast + 加速播放模式 + MPMovieReloadMode_Fast KSYMoviePlayerDefines.h @@ -24,29 +24,9 @@ - //apple_ref/c/econst/MPMovieVideoDecoderMode_Hardware - 视频解码方式采用硬解 - MPMovieVideoDecoderMode_Hardware - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/MPMovieVideoDecoderMode_AUTO - 自动选择解码方式，8.0以上的系统优先选择硬解 - MPMovieVideoDecoderMode_AUTO - - KSYMoviePlayerDefines.h - - - - - - //apple_ref/c/econst/MPMovieVideoDecoderMode_DisplayLayer - 使用系统接口进行解码和渲染，只适用于8.0及以上系统，低于8.0的系统自动使用软解 - MPMovieVideoDecoderMode_DisplayLayer + //apple_ref/c/econst/MPMovieReloadMode_Accurate + 精确检测模式 + MPMovieReloadMode_Accurate KSYMoviePlayerDefines.h diff --git a/doc/docset/Contents/Resources/Tokens84.xml b/doc/docset/Contents/Resources/Tokens84.xml index 7e54a04..94a151f 100644 --- a/doc/docset/Contents/Resources/Tokens84.xml +++ b/doc/docset/Contents/Resources/Tokens84.xml @@ -1,10 +1,10 @@ - + - //apple_ref/c/tdef/MPMovieVideoDeinterlaceMode - 视频反交错模式 + //apple_ref/c/tdef/MPMovieStatus + status类型 KSYMoviePlayerDefines.h @@ -14,9 +14,9 @@ - //apple_ref/c/econst/MPMovieVideoDeinterlaceMode_None - 关闭反交错 - MPMovieVideoDeinterlaceMode_None + //apple_ref/c/econst/MPMovieStatusVideoDecodeWrong + 视频解码出错 + MPMovieStatusVideoDecodeWrong KSYMoviePlayerDefines.h @@ -24,9 +24,39 @@ - //apple_ref/c/econst/MPMovieVideoDeinterlaceMode_Auto - 自动判断是否打开反交错 - MPMovieVideoDeinterlaceMode_Auto + //apple_ref/c/econst/MPMovieStatusAudioDecodeWrong + 音频解码出错 + MPMovieStatusAudioDecodeWrong + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieStatusHWCodecUsed + 使用硬件解码 + MPMovieStatusHWCodecUsed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieStatusSWCodecUsed + 使用软件解码 + MPMovieStatusSWCodecUsed + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieStatusDLCodecUsed + 使用AVSampleBufferDisplayLayer解码渲染 + MPMovieStatusDLCodecUsed KSYMoviePlayerDefines.h diff --git a/doc/docset/Contents/Resources/Tokens85.xml b/doc/docset/Contents/Resources/Tokens85.xml index 3fc40be..c1487e0 100644 --- a/doc/docset/Contents/Resources/Tokens85.xml +++ b/doc/docset/Contents/Resources/Tokens85.xml @@ -1,8 +1,57 @@ - + + + //apple_ref/c/tdef/MPMovieVideoDecoderMode + 视频解码模式 + KSYMoviePlayerDefines.h + + + + + + + + //apple_ref/c/econst/MPMovieVideoDecoderMode_Software + 视频解码方式采用软解 + MPMovieVideoDecoderMode_Software + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieVideoDecoderMode_Hardware + 视频解码方式采用硬解 + MPMovieVideoDecoderMode_Hardware + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieVideoDecoderMode_AUTO + 自动选择解码方式，8.0以上的系统优先选择硬解 + MPMovieVideoDecoderMode_AUTO + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieVideoDecoderMode_DisplayLayer + 使用系统接口进行解码和渲染，只适用于8.0及以上系统，低于8.0的系统自动使用软解 + MPMovieVideoDecoderMode_DisplayLayer + + KSYMoviePlayerDefines.h + + + diff --git a/doc/docset/Contents/Resources/Tokens86.xml b/doc/docset/Contents/Resources/Tokens86.xml index 3fc40be..30a1f3f 100644 --- a/doc/docset/Contents/Resources/Tokens86.xml +++ b/doc/docset/Contents/Resources/Tokens86.xml @@ -1,8 +1,37 @@ - + + + //apple_ref/c/tdef/MPMovieVideoDeinterlaceMode + 视频反交错模式 + KSYMoviePlayerDefines.h + + + + + + + + //apple_ref/c/econst/MPMovieVideoDeinterlaceMode_None + 关闭反交错 + MPMovieVideoDeinterlaceMode_None + + KSYMoviePlayerDefines.h + + + + + + //apple_ref/c/econst/MPMovieVideoDeinterlaceMode_Auto + 自动判断是否打开反交错 + MPMovieVideoDeinterlaceMode_Auto + + KSYMoviePlayerDefines.h + + + diff --git a/doc/docset/Contents/Resources/Tokens92.xml b/doc/docset/Contents/Resources/Tokens92.xml new file mode 100644 index 0000000..3fc40be --- /dev/null +++ b/doc/docset/Contents/Resources/Tokens92.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/doc/docset/Contents/Resources/Tokens93.xml b/doc/docset/Contents/Resources/Tokens93.xml new file mode 100644 index 0000000..3fc40be --- /dev/null +++ b/doc/docset/Contents/Resources/Tokens93.xml @@ -0,0 +1,9 @@ + + + + + + + + + \ No newline at end of file diff --git a/doc/docset/Contents/Resources/docSet.dsidx b/doc/docset/Contents/Resources/docSet.dsidx index f0dab4c..9119d42 100644 Binary files a/doc/docset/Contents/Resources/docSet.dsidx and b/doc/docset/Contents/Resources/docSet.dsidx differ diff --git a/doc/docset/Contents/Resources/docSet.dsidx-shm b/doc/docset/Contents/Resources/docSet.dsidx-shm index 9225bb1..94b6661 100644 Binary files a/doc/docset/Contents/Resources/docSet.dsidx-shm and b/doc/docset/Contents/Resources/docSet.dsidx-shm differ diff --git a/doc/docset/Contents/Resources/docSet.dsidx-wal b/doc/docset/Contents/Resources/docSet.dsidx-wal index 784ae38..779c791 100644 Binary files a/doc/docset/Contents/Resources/docSet.dsidx-wal and b/doc/docset/Contents/Resources/docSet.dsidx-wal differ diff --git a/doc/docset/Contents/Resources/docSet.mom b/doc/docset/Contents/Resources/docSet.mom index 35b91bd..762bdf0 100644 Binary files a/doc/docset/Contents/Resources/docSet.mom and b/doc/docset/Contents/Resources/docSet.mom differ diff --git a/doc/docset/Contents/Resources/docSet.skidx b/doc/docset/Contents/Resources/docSet.skidx index bd20437..b256847 100644 Binary files a/doc/docset/Contents/Resources/docSet.skidx and b/doc/docset/Contents/Resources/docSet.skidx differ diff --git a/doc/docset/Contents/Resources/docSet.toc b/doc/docset/Contents/Resources/docSet.toc index b51400f..b80e99a 100644 Binary files a/doc/docset/Contents/Resources/docSet.toc and b/doc/docset/Contents/Resources/docSet.toc differ diff --git a/doc/docset/Contents/Resources/docSet.tokencache b/doc/docset/Contents/Resources/docSet.tokencache index 82cec41..8762a67 100644 Binary files a/doc/docset/Contents/Resources/docSet.tokencache and b/doc/docset/Contents/Resources/docSet.tokencache differ diff --git a/doc/html/Blocks/KSYNetworkReachability.html b/doc/html/Blocks/KSYNetworkReachability.html index 7f0aac1..4e8eace 100644 --- a/doc/html/Blocks/KSYNetworkReachability.html +++ b/doc/html/Blocks/KSYNetworkReachability.html @@ -3,11 +3,11 @@ - KSYNetworkReachability Block Reference + - +
    @@ -59,35 +59,15 @@

    -

    KSYNetworkReachability Block Reference

    +

    -
    - - - - -
    Declared inKSYReachability.h
    - - - - -

    Block Definition

    -

    KSYNetworkReachability

    - - -typedef void (^KSYNetworkReachability) (KSYReachability *reachability, SCNetworkConnectionFlags flags) - - - - -
    @@ -96,8 +76,6 @@

    KSYNetworkReachability

    Copyright © 2017 Kingsoft. All rights reserved.

    -

    Generated by appledoc 2.2.1 (build 1334).

    -
    diff --git a/doc/html/Blocks/KSYNetworkReachable.html b/doc/html/Blocks/KSYNetworkReachable.html index 3dadbe9..4e8eace 100644 --- a/doc/html/Blocks/KSYNetworkReachable.html +++ b/doc/html/Blocks/KSYNetworkReachable.html @@ -3,11 +3,11 @@ - KSYNetworkReachable Block Reference + - +
    @@ -59,35 +59,15 @@

    -

    KSYNetworkReachable Block Reference

    +

    -
    - - - - -
    Declared inKSYReachability.h
    - - - - -

    Block Definition

    -

    KSYNetworkReachable

    - - -typedef void (^KSYNetworkReachable) (KSYReachability *reachability) - - - - -
    diff --git a/doc/html/Blocks/KSYNetworkUnreachable.html b/doc/html/Blocks/KSYNetworkUnreachable.html index 3bbf78c..4e8eace 100644 --- a/doc/html/Blocks/KSYNetworkUnreachable.html +++ b/doc/html/Blocks/KSYNetworkUnreachable.html @@ -3,11 +3,11 @@ - KSYNetworkUnreachable Block Reference + - +
    @@ -59,35 +59,15 @@

    -

    KSYNetworkUnreachable Block Reference

    +

    -
    - - - - -
    Declared inKSYReachability.h
    - - - - -

    Block Definition

    -

    KSYNetworkUnreachable

    - - -typedef void (^KSYNetworkUnreachable) (KSYReachability *reachability) - - - - -
    @@ -96,8 +76,6 @@

    KSYNetworkUnreachable

    Copyright © 2017 Kingsoft. All rights reserved.

    -

    Generated by appledoc 2.2.1 (build 1334).

    -
    diff --git a/doc/html/Blocks/KSYPlyAudioDataBlock.html b/doc/html/Blocks/KSYPlyAudioDataBlock.html index 2c147c8..4e8eace 100644 --- a/doc/html/Blocks/KSYPlyAudioDataBlock.html +++ b/doc/html/Blocks/KSYPlyAudioDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyAudioDataBlock Block Reference + - +
    @@ -59,54 +59,15 @@

    -

    KSYPlyAudioDataBlock Block Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerController.h
    - - - - -

    Block Definition

    -

    KSYPlyAudioDataBlock

    - - -
    -

    音频数据回调

    -
    - - - -typedef void (^KSYPlyAudioDataBlock) (CMSampleBufferRef sampleBuffer) - - - - - - - - - - - -
    -

    Declared In

    - KSYMoviePlayerController.h
    -
    - - -
    diff --git a/doc/html/Blocks/KSYPlyMessageDataBlock.html b/doc/html/Blocks/KSYPlyMessageDataBlock.html index 5bf86be..4e8eace 100644 --- a/doc/html/Blocks/KSYPlyMessageDataBlock.html +++ b/doc/html/Blocks/KSYPlyMessageDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyMessageDataBlock Block Reference + - +
    @@ -59,54 +59,15 @@

    -

    KSYPlyMessageDataBlock Block Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerController.h
    - - - - -

    Block Definition

    -

    KSYPlyMessageDataBlock

    - - -
    -

    message数据回调

    -
    - - - -typedef void (^KSYPlyMessageDataBlock) (NSDictionary *message, int64_t pts, int64_t param) - - - - - - - - - - - -
    -

    Declared In

    - KSYMoviePlayerController.h
    -
    - - -
    diff --git a/doc/html/Blocks/KSYPlyTextureBlock.html b/doc/html/Blocks/KSYPlyTextureBlock.html index 0b31220..4e8eace 100644 --- a/doc/html/Blocks/KSYPlyTextureBlock.html +++ b/doc/html/Blocks/KSYPlyTextureBlock.html @@ -3,11 +3,11 @@ - KSYPlyTextureBlock Block Reference + - +
    @@ -59,54 +59,15 @@

    -

    KSYPlyTextureBlock Block Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerController.h
    - - - - -

    Block Definition

    -

    KSYPlyTextureBlock

    - - -
    -

    texture回调

    -
    - - - -typedef void (^KSYPlyTextureBlock) (GLuint texId, int width, int height, double pts) - - - - - - - - - - - -
    -

    Declared In

    - KSYMoviePlayerController.h
    -
    - - -
    diff --git a/doc/html/Blocks/KSYPlyVideoDataBlock.html b/doc/html/Blocks/KSYPlyVideoDataBlock.html index 4d2c168..4e8eace 100644 --- a/doc/html/Blocks/KSYPlyVideoDataBlock.html +++ b/doc/html/Blocks/KSYPlyVideoDataBlock.html @@ -3,11 +3,11 @@ - KSYPlyVideoDataBlock Block Reference + - +
    @@ -59,54 +59,15 @@

    -

    KSYPlyVideoDataBlock Block Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerController.h
    - - - - -

    Block Definition

    -

    KSYPlyVideoDataBlock

    - - -
    -

    视频数据回调

    -
    - - - -typedef void (^KSYPlyVideoDataBlock) (CMSampleBufferRef pixelBuffer) - - - - - - - - - - - -
    -

    Declared In

    - KSYMoviePlayerController.h
    -
    - - -
    diff --git a/doc/html/Categories/AVAudioSession+KSY.html b/doc/html/Categories/AVAudioSession+KSY.html index 7bc32d2..4e8eace 100644 --- a/doc/html/Categories/AVAudioSession+KSY.html +++ b/doc/html/Categories/AVAudioSession+KSY.html @@ -3,11 +3,11 @@ - AVAudioSession(KSY) Category Reference + - +
    @@ -43,54 +43,10 @@

    @@ -103,521 +59,15 @@

    -

    AVAudioSession(KSY) Category Reference

    +

    -
    - - - - -
    Declared inAVAudioSession+KSY.h
    - - -
    - -

    Overview

    -

    iOS的AVAudioSession 属性配置工具类

    - -
      -
    1. 主要是保证推流时有采集和播放音频的权限 AVAudioSessionCategoryPlayAndRecord
      2. -
    2. 将一些常用的AVAudioSession的配置项提取为属性, 方便设置
      3. -
    3. 提供查询和修改当前音频采集设备相关的工具函数 比如查询是否有耳机
      4. -
    - -
    - - - -
    - - - - - - -
    -
    - -

    – setDefaultCfg -

    - -
    -
    - -
    - - -
    -

    设置默认配置

    -
    - - - -
    - (void)setDefaultCfg
    - - - - - - - - - -
    -

    Discussion

    -

    bInterruptOtherAudio : NO

    bDefaultToSpeaker : YES

    bAllowBluetooth : YES

    AVAudioSessionCategory : AVAudioSessionCategoryPlayAndRecord

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

      bInterruptOtherAudio -

    - -
    -
    - -
    - - -
    -

    是否打断其他后台的音乐播放 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL bInterruptOtherAudio
    - - - - - - - - - -
    -

    Discussion

    -

    也可以理解为是否允许在其他后台音乐播放的同时进行采集

    YES:开始采集时，会打断其他的后台播放音乐，也会被其他音乐打断（采集过程中，启动其他音乐播放，音频采集被中止）

    NO: 可以与其他后台播放共存，相互之间不会被打断

    参考 AVAudioSessionCategoryOptionMixWithOthers

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

      bDefaultToSpeaker -

    - -
    -
    - -
    - - -
    -

    启动采集后,是否从扬声器播放声音 (默认为YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bDefaultToSpeaker
    - - - - - - - - - -
    -

    Discussion

    -

    启动声音采集后,iOS系统的行为是默认从听筒播放声音的

    将该属性设为YES, 则改为默认从扬声器播放

    参考 AVAudioSessionCategoryOptionDefaultToSpeaker

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

      bAllowBluetooth -

    - -
    -
    - -
    - - -
    -

    是否启用蓝牙设备 (默认为YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bAllowBluetooth
    - - - - - - - - - -
    -

    Discussion

    -

    参考 AVAudioSessionCategoryOptionAllowBluetooth

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

      AVAudioSessionCategory -

    - -
    -
    - -
    - - -
    -

    本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord)

    -
    - - - -
    @property (nonatomic, assign) NSString *AVAudioSessionCategory
    - - - - - - - - - -
    -

    Discussion

    -

    用于指定推流过程中需要采集和播放音频的权限

    Warning: 如无必要请勿修改

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

    + isBluetoothInputAvaible -

    - -
    -
    - -
    - - -
    -

    是否有蓝牙麦克风可用

    -
    - - - -
    + (BOOL)isBluetoothInputAvaible
    - - - - - -
    -

    Return Value

    -

    是/否有蓝牙麦克风可用

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

    + switchBluetoothInput: -

    - -
    -
    - -
    - - -
    -

    选择是否使用蓝牙麦克风

    -
    - - - -
    + (BOOL)switchBluetoothInput:(BOOL)onOrOff
    - - - -
    -

    Parameters

    - - - - - - - -
    onOrOff

    : YES 使用蓝牙麦克风 NO

    -
    - - - -
    -

    Return Value

    -

    是/否有蓝牙麦克风可用

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

    + isHeadsetInputAvaible -

    - -
    -
    - -
    - - -
    -

    是否有耳机麦克风可用

    -
    - - - -
    + (BOOL)isHeadsetInputAvaible
    - - - - - -
    -

    Return Value

    -

    是/否有耳机麦克风

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

    + isHeadsetPluggedIn -

    - -
    -
    - -
    - - -
    -

    查询当前是否有耳机(包括蓝牙耳机)

    -
    - - - -
    + (BOOL)isHeadsetPluggedIn
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    - -

      currentMicType -

    - -
    -
    - -
    - - -
    -

    当前使用的音频采集设备

    -
    - - - -
    @property KSYMicType currentMicType
    - - - - - - - - - -
    -

    Discussion

    -

    当设置新值时, 如果修改成功, 重新查询为新值, 修改不成功值不变

    参考 KSYMicType

    -
    - - - - - - - -
    -

    Declared In

    -

    AVAudioSession+KSY.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYAQPlayer.html b/doc/html/Classes/KSYAQPlayer.html index 56167bf..4e8eace 100644 --- a/doc/html/Classes/KSYAQPlayer.html +++ b/doc/html/Classes/KSYAQPlayer.html @@ -3,11 +3,11 @@ - KSYAQPlayer Class Reference + - +
    @@ -43,60 +43,10 @@

    @@ -109,738 +59,15 @@

    -

    KSYAQPlayer Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAQPlayer.h
    - - -
    - -

    Overview

    -

    基于AudioQueue的音乐播放器

    - -
    * 提供声音播放的功能
-* 通过回调拉取新的数据
-* 提供音量和音调调节功能
-* 能将播放后的音频数据通过回调送出 (回调的数据为音效处理之后的数据)
-
    -
    - - - - - -
    - - - - - - -
    -
    - -

    – play: -

    - -
    -
    - -
    - - -
    -

    开始播放

    -
    - - - -
    - (BOOL)play:(AudioStreamBasicDescription *)fmt
    - - - -
    -

    Parameters

    - - - - - - - -
    fmt,

    后续送入的音频数据的格式

    -
    - - - -
    -

    Return Value

    -

    是否能够开始播放

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

    – stop -

    - -
    -
    - -
    - - -
    -

    停止播放背景音乐

    -
    - - - -
    - (void)stop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

    – pause -

    - -
    -
    - -
    - - -
    -

    暂停播放背景音乐

    -
    - - - -
    - (void)pause
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

    – resume -

    - -
    -
    - -
    - - -
    -

    恢复播放背景音乐

    -
    - - - -
    - (void)resume
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      volume -

    - -
    -
    - -
    - - -
    -

    播放音量

    -
    - - - -
    @property (nonatomic, assign) double volume
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 0.0~1.0, 默认为1

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      pitch -

    - -
    -
    - -
    - - -
    -

    播放声音的音调

    -
    - - - -
    @property (nonatomic, assign) double pitch
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 [-24.0 ~ 24.0], 默认为0.01, 单位为半音

    0.01 为1度, 1.0为一个半音, 12个半音为1个八度

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      playRate -

    - -
    -
    - -
    - - -
    -

    播放速度

    -
    - - - -
    @property (nonatomic, assign) double playRate
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 0.5~2.0, 默认为1

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      inFmt -

    - -
    -
    - -
    - - -
    -

    输入的音频格式

    -
    - - - -
    @property (nonatomic, readonly) AudioStreamBasicDescription inFmt
    - - - - - - - - - -
    -

    Discussion

    -

    每次输入音频格式可能变化时,请重新调用play: 方法

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      outFmt -

    - -
    -
    - -
    - - -
    -

    回调输出的音频格式

    -
    - - - -
    @property (nonatomic, readonly) AudioStreamBasicDescription outFmt
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      mute -

    - -
    -
    - -
    - - -
    -

    背景音乐播放静音

    -
    - - - -
    @property (nonatomic, assign) BOOL mute
    - - - - - - - - - -
    -

    Discussion

    -

    仅仅静音播放, 不影响回调的音频数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      pullDataCB -

    - -
    -
    - -
    - - -
    -

    音频数据输入回调

    -
    - - - -
    @property (nonatomic, copy) BOOL ( ^ ) ( AudioQueueBufferRef buf ) pullDataCB
    - - - - - - - - - -
    -

    Discussion

    -

    buf 送入的音频数据

    -
    - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      putDataCB -

    - -
    -
    - -
    - - -
    -

    音频数据输出回调

    -
    - - - -
    @property (nonatomic, copy) BOOL ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime pts ) putDataCB
    - - - - - - - - - -
    -

    Discussion

    -

    pData 回调输出的数据指针

    len sample数

    fmt 数据的格式

    pts 目前没有时间戳输出

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      isRunning -

    - -
    -
    - -
    - - -
    -

    音频播放是否运行

    -
    - - - -
    @property (nonatomic, readonly) BOOL isRunning
    - - - - - - - - - -
    -

    Discussion

    -

    音频是否输出到speaker播放

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      isPaused -

    - -
    -
    - -
    - - -
    -

    音频播放是否暂停

    -
    - - - -
    @property (nonatomic, readonly) BOOL isPaused
    - - - - - - - - - -
    -

    Discussion

    -

    通过 pause/resume 改变状态

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    - -

      audioErrorCode -

    - -
    -
    - -
    - - -
    -

    播放错误码

    -
    - - - -
    @property (nonatomic, readonly) OSStatus audioErrorCode
    - - - - - - - - - -
    -

    Discussion

    -

    播放错误码具体内容可以参考AudioQueue的Apple文档。

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAQPlayer.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYAUAudioCapture.html b/doc/html/Classes/KSYAUAudioCapture.html index c1003e7..4e8eace 100644 --- a/doc/html/Classes/KSYAUAudioCapture.html +++ b/doc/html/Classes/KSYAUAudioCapture.html @@ -3,11 +3,11 @@ - KSYAUAudioCapture Class Reference + - +
    @@ -43,72 +43,10 @@

    @@ -121,940 +59,23 @@

    -

    KSYAUAudioCapture Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAUAudioCapture.h
    - - -
    - -

    Overview

    -

    音频采集模块

    -
      -
    1. 基于 AudioUnit 实现的低延时音频采集模块
      2. -
    2. 支持对采集的语音添加混响音效 (目前提供了4种类型的混响场景)
      3. -
    3. 支持将采集的声音低延时播放,帮助主播选择音效 (又称"耳返")
      4. -
    4. 支持对采集的音频进行降噪处理
      5. -
    5. 采集的声音通过回调函数提供出来
      6. -
    6. 当启用噪声抑制功能时,输出音频数据的采样率为16K(重采样得到,与采集的采样率无关)
      7. -
    - -
    - - - -
    - - + +
    - - - -
    -
    - -

    – initWithSampleRate: -

    - -
    -
    - -
    - - -
    -

    指定采集音频的采样率

    -
    - - - -
    - (id)initWithSampleRate:(double)sampleRate
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleRate

    指定的采样率 , 默认为44100Hz

    -
    - - - -
    -

    Return Value

    -

    采集设备实例

    -
    - - - - - -
    -

    Discussion

    -

    Warning: 请尽量使用默认的44100, 使用其他的采样率可能导致混响和变声等功能异常

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    – startCapture -

    - -
    -
    - -
    - - -
    -

    启动音频采集, 占据麦克风资源

    -
    - - - -
    - (BOOL)startCapture
    - - - - - -
    -

    Return Value

    -

    是否启动采集成功

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    – stopCapture -

    - -
    -
    - -
    - - -
    -

    停止音频采集, 释放麦克风资源

    -
    - - - -
    - (void)stopCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    – pauseCapture -

    - -
    -
    - -
    - - -
    -

    暂停音频采集(仍然占用麦克风资源) 停止回调音频数据

    -
    - - - -
    - (BOOL)pauseCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    – pauseWithMuteData -

    - -
    -
    - -
    - - -
    -

    暂停音频采集(仍然占用麦克风资源), 回调静音音频数据

    -
    - - - -
    - (BOOL)pauseWithMuteData
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    – resumeCapture -

    - -
    -
    - -
    - - -
    -

    恢复正常音频采集和回调

    -
    - - - -
    - (BOOL)resumeCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      bPlayCapturedAudio -

    - -
    -
    - -
    - - -
    -

    是否播放采集的声音 (又称"耳返")

    -
    - - - -
    @property (nonatomic, assign) BOOL bPlayCapturedAudio
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: 如果在没有插入耳机的情况下启动, 容易出现很刺耳的声音

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      enableVoiceProcess -

    - -
    -
    - -
    - - -
    -

    是否使用带回声消除的采集模块(默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL enableVoiceProcess
    - - - - - - - - - -
    -

    Discussion

    -

    请在连麦开始时在设置此属性为YES, 连麦结束记得设置为NO

    此属性为YES时, 启动采集一定会打断其他音乐播放

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      noiseSuppressionLevel -

    - -
    -
    - -
    - - -
    -

    噪声抑制处理的等级(默认为KSYAudioNoiseSuppress_OFF)

    -
    - - - -
    @property (nonatomic, assign) KSYAudioNoiseSuppress noiseSuppressionLevel
    - - - - - - - - - -
    -

    Discussion

    -

    当启用噪声抑制处理后, 内部会进行输出音频数据的

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      bForceAudioSessionCatogary -

    - -
    -
    - -
    - - -
    -

    是否强制设置AVAudioSession的类别为PlayAndRecord(默认为YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bForceAudioSessionCatogary
    - - - - - - - - - -
    -

    Discussion

    -

    此属性为YES时, 每次启动采集会将类别强制设置为AVAudioSessionCategoryPlayAndRecord

    为了避免别APP中的其他SDK将AVAudioSession的类别修改为无法录音,导致无法采集到声音

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      micVolume -

    - -
    -
    - -
    - - -
    -

    设置mic采集的声音音量

    -
    - - - -
    @property (nonatomic, assign) Float32 micVolume
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 0.0~1.0

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      outputPts -

    - -
    -
    - -
    - - -
    -

    最近一次输出的音频包的时间戳

    -
    - - - -
    @property (nonatomic, readonly) CMTime outputPts
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      reverbType -

    - -
    -
    - -
    - - -
    -

    混响类型

    -
    - - - -
    @property (nonatomic, assign) int reverbType
    - - - - - - - - - -
    -

    Discussion

    -

    目前提供了4种类型的混响场景, type和场景的对应关系如下

    - -
      -
    • 0 关闭
      • -
    • 1 录音棚
      • -
    • 2 ktv
      • -
    • 3 小舞台
      • -
    • 4 演唱会
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      effectType -

    - -
    -
    - -
    - - -
    -

    音效类型

    -
    - - - -
    @property (nonatomic, assign) KSYAudioEffectType effectType
    - - - - - - - - - -
    -

    Discussion

    -

    音效类型仅在enableVoiceProcess=NO时有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    采集数据输出回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 为采集到的音频数据

    与pcmProcessingCallback两者只能二选一, 设置 audioProcessingCallback 会清空pcmProcessingCallback

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      pcmProcessingCallback -

    - -
    -
    - -
    - - -
    -

    采集数据输出回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime timeInfo ) pcmProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    pData 和 len 为采集数据和长度 (目前只支持单声道, 只有pData[0]为有效数据指针 )

    与audioProcessingCallback两者只能二选一, 设置 pcmProcessingCallback 会清空audioProcessingCallback

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      customPlayCallback -

    - -
    -
    - -
    - - -
    -

    用户可以自定义播放的内容，直接把数据填入ioData

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( AudioBufferList *ioData , UInt32 inumber ) customPlayCallback
    - - - - - - - - - -
    -

    Discussion

    -

    ioData 目前只支持int16 的单声道数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

    + isHeadsetPluggedIn -

    - -
    -
    - -
    - - -
    -

    是否有耳机麦克风可用

    -
    - - - -
    + (BOOL)isHeadsetPluggedIn
    - - - - - -
    -

    Return Value

    -

    是/否有耳机麦克风

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    - -

      isRunning -

    - -
    -
    - -
    - - -
    -

    设备是否正在采集音频数据

    -
    - - - -
    @property (nonatomic, readonly) BOOL isRunning
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAUAudioCapture.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYAVAudioSession.html b/doc/html/Classes/KSYAVAudioSession.html index 1424209..4e8eace 100644 --- a/doc/html/Classes/KSYAVAudioSession.html +++ b/doc/html/Classes/KSYAVAudioSession.html @@ -3,11 +3,11 @@ - KSYAVAudioSession Class Reference + - +
    @@ -43,56 +43,10 @@

    @@ -105,570 +59,15 @@

    -

    KSYAVAudioSession Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAVAudioSession.h
    - - -
    - -

    Overview

    -

    iOS的AVAudioSession 属性配置工具类

    - -
      -
    1. 主要是保证推流时有采集和播放音频的权限 AVAudioSessionCategoryPlayAndRecord
      2. -
    2. 将一些常用的AVAudioSession的配置项提取为属性, 方便设置
      3. -
    3. 提供查询和修改当前音频采集设备相关的工具函数 比如查询是否有耳机
      4. -
    - -
    - - - - - -
    - - - - - - -
    -
    - -

      bInterruptOtherAudio -

    - -
    -
    - -
    - - -
    -

    是否打断其他后台的音乐播放 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL bInterruptOtherAudio
    - - - - - - - - - -
    -

    Discussion

    -

    也可以理解为是否允许在其他后台音乐播放的同时进行采集

    YES:开始采集时，会打断其他的后台播放音乐，也会被其他音乐打断（采集过程中，启动其他音乐播放，音频采集被中止）

    NO: 可以与其他后台播放共存，相互之间不会被打断

    参考 AVAudioSessionCategoryOptionMixWithOthers

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

      bDefaultToSpeaker -

    - -
    -
    - -
    - - -
    -

    启动采集后,是否从扬声器播放声音 (默认为YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bDefaultToSpeaker
    - - - - - - - - - -
    -

    Discussion

    -

    启动声音采集后,iOS系统的行为是默认从听筒播放声音的

    将该属性设为YES, 则改为默认从扬声器播放

    参考 AVAudioSessionCategoryOptionDefaultToSpeaker

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

      bAllowBluetooth -

    - -
    -
    - -
    - - -
    -

    是否启用蓝牙设备 (默认为YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bAllowBluetooth
    - - - - - - - - - -
    -

    Discussion

    -

    参考 AVAudioSessionCategoryOptionAllowBluetooth

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    – setAVAudioSessionOption -

    - -
    -
    - -
    - - -
    -

    设置声音采集需要的AUAudioSession的参数

    -
    - - - -
    - (void)setAVAudioSessionOption
    - - - - - - - - - -
    -

    Discussion

    -

    按照属性的设置值刷新AUAudioSession的配置

    参考 AUAudioSession

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

      AVAudioSessionCategory -

    - -
    -
    - -
    - - -
    -

    本SDK使用的AVAudioSession的类别 (默认为AVAudioSessionCategoryPlayAndRecord)

    -
    - - - -
    @property (nonatomic, assign) NSString *AVAudioSessionCategory
    - - - - - - - - - -
    -

    Discussion

    -

    用于指定推流过程中需要采集和播放音频的权限

    Warning: 如无必要请勿修改

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    – checkCategory -

    - -
    -
    -
    - - -
    -

    检查当前AVAudioSession的类别是否与设置的AVAudioSessionCategory 一致

    -
    - - - -
    - (BOOL)checkCategory
    - - - - - - - - - -
    -

    Discussion

    -

    AVAudioSession为公有的单例, APP中的其他SDK也可以修改

    因此可能出现直播时,改为无录音权限的类别的情况, 通过此方法进行检查

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    + isBluetoothInputAvaible -

    - -
    -
    - -
    - - -
    -

    是否有蓝牙麦克风可用

    -
    - - - -
    + (BOOL)isBluetoothInputAvaible
    - - - - - -
    -

    Return Value

    -

    是/否有蓝牙麦克风可用

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    + switchBluetoothInput: -

    - -
    -
    - -
    - - -
    -

    选择是否使用蓝牙麦克风

    -
    - - - -
    + (BOOL)switchBluetoothInput:(BOOL)onOrOff
    - - - -
    -

    Parameters

    - - - - - - - -
    onOrOff

    : YES 使用蓝牙麦克风 NO

    -
    - - - -
    -

    Return Value

    -

    是/否有蓝牙麦克风可用

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    + isHeadsetInputAvaible -

    - -
    -
    - -
    - - -
    -

    是否有耳机麦克风可用

    -
    - - - -
    + (BOOL)isHeadsetInputAvaible
    - - - - - -
    -

    Return Value

    -

    是/否有耳机麦克风

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

    + isHeadsetPluggedIn -

    - -
    -
    - -
    - - -
    -

    查询当前是否有耳机(包括蓝牙耳机)

    -
    - - - -
    + (BOOL)isHeadsetPluggedIn
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    - -

      currentMicType -

    - -
    -
    - -
    - - -
    -

    当前使用的音频采集设备

    -
    - - - -
    @property KSYMicType currentMicType
    - - - - - - - - - -
    -

    Discussion

    -

    当设置新值时, 如果修改成功, 重新查询为新值, 修改不成功值不变

    参考 KSYMicType

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVAudioSession.h

    -
    - - -
    -
    -
    -
    - -
    - - -

    diff --git a/doc/html/Classes/KSYAVFCapture.html b/doc/html/Classes/KSYAVFCapture.html index d64a274..4e8eace 100644 --- a/doc/html/Classes/KSYAVFCapture.html +++ b/doc/html/Classes/KSYAVFCapture.html @@ -3,11 +3,11 @@ - KSYAVFCapture Class Reference + - +
    @@ -43,96 +43,10 @@

    @@ -145,1449 +59,23 @@

    -

    KSYAVFCapture Class Reference

    +

    -
    - - - - - - - - - - -
    Inherits fromNSObject
    Conforms toAVCaptureAudioDataOutputSampleBufferDelegate
    AVCaptureVideoDataOutputSampleBufferDelegate
    Declared inKSYAVFCapture.h
    - - -
    - -

    Overview

    -

    基于 AVFoundation的 音视频采集模块

    -
      -
    • 通过回调将采集的音频和视频数据传出
      • -
    • 将摄像头和音频的常用操作进行封装
      • -
    • 注意: 使用AVFoundation的音频采集时,可能无法进行后台采集
      • -
    - -
    - - - -
    - - + +
    - -

    Other Methods

    - -
    -
    - -

      isRunning -

    - -
    -
    - -
    - - -
    -

    Whether or not the underlying AVCaptureSession is running

    -
    - - - -
    @property (readonly, nonatomic) BOOL isRunning
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      captureSession -

    - -
    -
    - -
    - - -
    -

    The AVCaptureSession used to capture from the camera

    -
    - - - -
    @property (readonly, retain, nonatomic) AVCaptureSession *captureSession
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      captureSessionPreset -

    - -
    -
    - -
    - - -
    -

    This enables the capture session preset to be changed on the fly

    -
    - - - -
    @property (readwrite, nonatomic, copy) NSString *captureSessionPreset
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      frameRate -

    - -
    -
    - -
    - - -
    -

    采集帧率 有效范围为 0~30

    -
    - - - -
    @property (readwrite) int32_t frameRate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      outputPixelFmt -

    - -
    -
    - -
    - - -
    -

    输出图像的像素格式 有效值 为 NV12 和BGRA - - kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange - - kCVPixelFormatType_420YpCbCr8BiPlanarFullRange - - kCVPixelFormatType_32BGRA

    -
    - - - -
    @property (readwrite) OSType outputPixelFmt
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      frontFacingCameraPresent -

    - -
    -
    - -
    - - -
    -

    Easy way to tell which cameras are present on device

    -
    - - - -
    @property (readonly, getter=isFrontFacingCameraPresent) BOOL frontFacingCameraPresent
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      backFacingCameraPresent -

    - -
    -
    - -
    - - -
    -

    Easy way to tell which cameras are present on device

    -
    - - - -
    @property (readonly, getter=isBackFacingCameraPresent) BOOL backFacingCameraPresent
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      inputCamera -

    - -
    -
    - -
    - - -
    -

    Use this property to manage camera settings. Focus point, exposure point, etc.

    -
    - - - -
    @property (readonly) AVCaptureDevice *inputCamera
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      outputImageOrientation -

    - -
    -
    - -
    - - -
    -

    This determines the rotation applied to the output image, based on the source material

    -
    - - - -
    @property (readwrite, nonatomic) UIInterfaceOrientation outputImageOrientation
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      bMirrorRearCamera -

    - -
    -
    - -
    - - -
    -

    These properties determine whether or not the two camera orientations should be mirrored. By default, (YES, NO).

    -
    - - - -
    @property (readwrite, nonatomic) BOOL bMirrorFrontCamera , bMirrorRearCamera
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    + isBackFacingCameraPresent -

    - -
    -
    - -
    - - -
    -

    后置摄像头是否存在

    -
    - - - -
    + (BOOL)isBackFacingCameraPresent
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    + isFrontFacingCameraPresent -

    - -
    -
    - -
    - - -
    -

    前置摄像头是否存在

    -
    - - - -
    + (BOOL)isFrontFacingCameraPresent
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    + uiOrientationToAVOrientation: -

    - -
    -
    - -
    - - -
    -

    UIInterfaceOrientation 转为 AVCaptureVideoOrientation

    -
    - - - -
    + (AVCaptureVideoOrientation)uiOrientationToAVOrientation:(UIInterfaceOrientation)orien
    - - - -
    -

    Parameters

    - - - - - - - -
    orien

    UI 的朝向,比如状态栏相对Home键的位置

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    -
    - - - -

    Initialization and teardown

    - -
    -
    - -

    – initWithSessionPreset:cameraPosition: -

    - -
    -
    - -
    - - -
    -

    Begin a capture session

    -
    - - - -
    - (id)initWithSessionPreset:(NSString *)sessionPreset cameraPosition:(AVCaptureDevicePosition)cameraPosition
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    sessionPreset

    Session preset to use

    cameraPosition

    Camera to capture from

    -
    - - - - - - - -
    -

    Discussion

    -

    See AVCaptureSession for acceptable values

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – addAudioInputsAndOutputs -

    - -
    -
    - -
    - - -
    -

    Add audio capture to the session. Adding inputs and outputs freezes the capture session momentarily, so you - can use this method to add the audio inputs and outputs early, if you’re going to set the audioEncodingTarget - later. Returns YES is the audio inputs and outputs were added, or NO if they had already been added.

    -
    - - - -
    - (BOOL)addAudioInputsAndOutputs
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – removeAudioInputsAndOutputs -

    - -
    -
    - -
    - - -
    -

    Remove the audio capture inputs and outputs from this session. Returns YES if the audio inputs and outputs - were removed, or NO is they hadn’t already been added.

    -
    - - - -
    - (BOOL)removeAudioInputsAndOutputs
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – removeInputsAndOutputs -

    - -
    -
    - -
    - - -
    -

    Tear down the capture session

    -
    - - - -
    - (void)removeInputsAndOutputs
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    -
    - - - -

    Manage the camera video stream

    - -
    -
    - -

    – startCameraCapture -

    - -
    -
    - -
    - - -
    -

    Start camera capturing

    -
    - - - -
    - (void)startCameraCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – stopCameraCapture -

    - -
    -
    - -
    - - -
    -

    Stop camera capturing

    -
    - - - -
    - (void)stopCameraCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – pauseCameraCapture -

    - -
    -
    - -
    - - -
    -

    Pause camera capturing

    -
    - - - -
    - (void)pauseCameraCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – resumeCameraCapture -

    - -
    -
    - -
    - - -
    -

    Resume camera capturing

    -
    - - - -
    - (void)resumeCameraCapture
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – cameraPosition -

    - -
    -
    - -
    - - -
    -

    Get the position (front, rear) of the source camera

    -
    - - - -
    - (AVCaptureDevicePosition)cameraPosition
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – videoCaptureConnection -

    - -
    -
    - -
    - - -
    -

    Get the AVCaptureConnection of the source camera

    -
    - - - -
    - (AVCaptureConnection *)videoCaptureConnection
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – rotateCamera -

    - -
    -
    - -
    - - -
    -

    This flips between the front and rear cameras

    -
    - - - -
    - (void)rotateCamera
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – captureDimension -

    - -
    -
    - -
    - - -
    -

    查询实际的采集分辨率

    -
    - - - -
    - (CGSize)captureDimension
    - - - - - - - - - -
    -

    Discussion

    -

    参见iOS的 AVCaptureSessionPresetXXX的定义

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – isTorchSupported -

    - -
    -
    - -
    - - -
    -

    当前采集设备是否支持闪光灯

    -
    - - - -
    - (BOOL)isTorchSupported
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - -
    -

    Discussion

    -

    通常只有后置摄像头支持闪光灯

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – toggleTorch -

    - -
    -
    - -
    - - -
    -

    开关闪光灯

    -
    - - - -
    - (void)toggleTorch
    - - - - - - - - - -
    -

    Discussion

    -

    切换闪光灯的开关状态 开 <–> 关

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

    – setTorchMode: -

    - -
    -
    - -
    - - -
    -

    设置闪光灯

    -
    - - - -
    - (void)setTorchMode:(AVCaptureTorchMode)mode
    - - - -
    -

    Parameters

    - - - - - - - -
    mode

    AVCaptureTorchModeOn/Off

    -
    - - - - - - - -
    -

    Discussion

    -

    设置闪光灯的开关状态

    开始预览后开始有效

    请参考 AVCaptureTorchMode

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 原始采集到的音频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题@discussion 请参考 CMSampleBufferRef

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      videoProcessingCallback -

    - -
    -
    - -
    - - -
    -

    视频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 原始采集到的视频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    - -

      interruptCallback -

    - -
    -
    - -
    - - -
    -

    采集被打断的消息通知

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( BOOL bInterrupt ) interruptCallback
    - - - - - - - - - -
    -

    Discussion

    -

    bInterrupt 为YES, 表明被打断, 采集暂停

    bInterrupt 为NO, 表明恢复采集

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVFCapture.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYAVMuxer.html b/doc/html/Classes/KSYAVMuxer.html index 85ff877..4e8eace 100644 --- a/doc/html/Classes/KSYAVMuxer.html +++ b/doc/html/Classes/KSYAVMuxer.html @@ -3,11 +3,11 @@ - KSYAVMuxer Class Reference + - +
    @@ -43,44 +43,10 @@

    @@ -93,400 +59,15 @@

    -

    KSYAVMuxer Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAVMuxer.h
    - - -
    - -

    Overview

    -

    音视频交织工具类

    - -
      -
    • 将输入的纯音频文件和纯视频文件交织输出为正常的视频文件
      • -
    • 本工具类不做解码和编码,仅仅将音视频交织
      • -
    • 视频文件要求是只有单路图像, 如果有音频会被丢弃, 音频文件反之
      • -
    • 支持输出的文件格式: flv, MP4
      • -
    -
    - - - - -
    - - - - - - -
    -
    - -

      bLoopVideo -

    - -
    -
    - -
    - - -
    -

    当视频数据比音频数据短时,是否循环使用视频数据 （默认为NO）

    -
    - - - -
    @property (atomic, assign) BOOL bLoopVideo
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

      bLoopAudio -

    - -
    -
    - -
    - - -
    -

    当音频数据比视频数据短时,是否循环使用音频数据 （默认为NO）

    -
    - - - -
    @property (atomic, assign) BOOL bLoopAudio
    - - - - - - - - - -
    -

    Discussion

    -

    当bLoopVideo和bLoopAudio都为NO时, 比较长的数据被丢弃

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

      metadata -

    - -
    -
    - -
    - - -
    -

    最后输出视频文件时附带的metadata (默认为nil)

    -
    - - - -
    @property (atomic, copy) NSDictionary *metadata
    - - - - - - - - - -
    -

    Discussion

    -

    key 一定要是 NSString* 类型的

    -
    - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

    – startMuxVideo:andAudio:To: -

    - -
    -
    - -
    - - -
    -

    启动处理(同步)

    -
    - - - -
    - (void)startMuxVideo:(NSURL *)vFile andAudio:(NSURL *)aFile To:(NSURL *)oFile
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    vFile

    为输入的纯视频文件的路径

    aFile

    为输入的音频文件的路径

    oFile

    为输出文件的路径

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

    – asyncMuxVideo:andAudio:To: -

    - -
    -
    - -
    - - -
    -

    启动处理(异步)

    -
    - - - -
    - (void)asyncMuxVideo:(NSURL *)vFile andAudio:(NSURL *)aFile To:(NSURL *)oFile
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    vFile

    为输入的纯视频文件的路径

    aFile

    为输入的音频文件的路径

    oFile

    为输出文件的路径

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

    – cancelMux -

    - -
    -
    - -
    - - -
    -

    中止处理

    -
    - - - -
    - (void)cancelMux
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    - -

      muxCompleteBlock -

    - -
    -
    - -
    - - -
    -

    异步处理完成回调 -@param status

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( KSYAVMuxerStatus status ) muxCompleteBlock
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAVMuxer.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -

    diff --git a/doc/html/Classes/KSYAudioFilter.html b/doc/html/Classes/KSYAudioFilter.html index 1060538..4e8eace 100644 --- a/doc/html/Classes/KSYAudioFilter.html +++ b/doc/html/Classes/KSYAudioFilter.html @@ -3,11 +3,11 @@ - KSYAudioFilter Class Reference + - +
    @@ -43,36 +43,10 @@

    @@ -85,199 +59,15 @@

    -

    KSYAudioFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAudioFilter.h
    - - -
    - -

    Overview

    -

    音频filter -1. 使用filter对音频进行处理，目前支持功能包括： - * 变速 - speed -2. 输出格式与输入格式相同 -3. 建议放在KSYAudioMixer前使用

    -
    - - - -
    - - - - - - -
    -
    - -

      speed -

    - -
    -
    - -
    - - -
    -

    速率，默认值是1.0

    -
    - - - -
    @property (nonatomic, assign) float speed
    - - - - - - - - - -
    -

    Discussion

    -

    取值范围从0.5 - 2.0

    如果配置速率不在有效范围，则设置不生效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioFilter.h

    -
    - - -
    -
    -
    - -

    – processAudioSampleBuffer: -

    -
    -
    - -
    - - -
    -

    输入音频PCM

    -
    - - - -
    - (void)processAudioSampleBuffer:(CMSampleBufferRef)inSampleBuffer
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    音频数据

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioFilter.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 经过filter处理后的音频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYAudioInfo.html b/doc/html/Classes/KSYAudioInfo.html index 7e1c819..4e8eace 100644 --- a/doc/html/Classes/KSYAudioInfo.html +++ b/doc/html/Classes/KSYAudioInfo.html @@ -3,11 +3,11 @@ - KSYAudioInfo Class Reference + - +
    @@ -43,40 +43,10 @@

    @@ -89,337 +59,15 @@

    -

    KSYAudioInfo Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYMediaInfo.h
    - - -
    - -

    Overview

    -

    音频信息

    -
    - - - - - -
    - - - - - - -
    -
    - -

      acodec -

    - -
    -
    - -
    - - -
    -

    音频编码格式, 具体类型为MEDIAINFO_CODEC_ID

    -
    - - - -
    @property (nonatomic) MEDIAINFO_CODEC_ID acodec
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      language -

    - -
    -
    - -
    - - -
    -

    音频语言, 如chinese, english…

    -
    - - - -
    @property (nonatomic) NSString *language
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      bitrate -

    - -
    -
    - -
    - - -
    -

    音频码率

    -
    - - - -
    @property (nonatomic, assign) int64_t bitrate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      channels -

    - -
    -
    - -
    - - -
    -

    声道数

    -
    - - - -
    @property (nonatomic, assign) int32_t channels
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      samplerate -

    - -
    -
    - -
    - - -
    -

    音频采样率

    -
    - - - -
    @property (nonatomic, assign) int32_t samplerate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      sample_format -

    - -
    -
    - -
    - - -
    -

    音频采样格式, 具体类型为MEDIAINFO_SAMPLE_FMT

    -
    - - - -
    @property (nonatomic, assign) MEDIAINFO_SAMPLE_FMT sample_format
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      framesize -

    - -
    -
    - -
    - - -
    -

    音频帧大小

    -
    - - - -
    @property (nonatomic, assign) int32_t framesize
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYAudioMixer.html b/doc/html/Classes/KSYAudioMixer.html index 4da9c32..4e8eace 100644 --- a/doc/html/Classes/KSYAudioMixer.html +++ b/doc/html/Classes/KSYAudioMixer.html @@ -3,11 +3,11 @@ - KSYAudioMixer Class Reference + - +
    @@ -43,60 +43,10 @@

    @@ -109,862 +59,15 @@

    -

    KSYAudioMixer Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYAudioMixer.h
    - - -
    - -

    Overview

    -

    多路pcm混音

    - -
      -
    1. 用trackId来表示某一路音频，从0开始编号
      2. -
    2. 要求一定要有一路麦克风的音频，其他音频都叠加到麦克风上
      3. -
    3. 将输入的音频pcm数据存入buffer，每一路音频的buffer独立
      4. -
    4. 每次麦克风的音频输入，都会触发从所有buffer中取数据，混合，发送的动作
      5. -
    5. 每一路音频可以单独配置音量
      6. -
    6. 输出格式固定为 44.1KHz, S16 (声道数可设定)
      7. -
    -
    - - - - -
    - - - - - - -
    -
    - -

    – getMaxMixTrack -

    - -
    -
    - -
    - - -
    -

    获取最大支持的混合路数 -*

    -
    - - - -
    - (int)getMaxMixTrack
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – setMixVolume:of: -

    - -
    -
    - -
    - - -
    -

    设置混音音量（默认音量为1.0）

    -
    - - - -
    - (BOOL)setMixVolume:(float)vol of:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    vol

    音量比例（0.0~2.0） (<1.0 为缩小, > 1.0为放大)

    trackId

    设置对应track的

    -
    - - - -
    -

    Return Value

    -

    NO为设置失败，如track不存在，或vol超出范围

    -
    - - - - - -
    -

    Discussion

    -

    Warning: 设置放大的音量可能会出现爆音, 请注意 -*

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – getMixVolume: -

    - -
    -
    - -
    - - -
    -

    查询track的音量

    -
    - - - -
    - (float)getMixVolume:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - -
    trackId

    设置对应track的

    -
    - - - -
    -

    Return Value

    -

    负数为查询失败，如track不存在 -*

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – setTrack:enable: -

    - -
    -
    -
    - - -
    -

    开启/关闭一路声音

    -
    - - - -
    - (BOOL)setTrack:(int)trackId enable:(BOOL)onOff
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    trackId

    开关对应track

    onOff

    开关， 0号track默认开启

    -
    - - - -
    -

    Return Value

    -

    NO为设置失败，比如trackID不存在 -*

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – getTrackEnable: -

    - -
    -
    - -
    - - -
    -

    查询track是否开启

    -
    - - - -
    - (BOOL)getTrackEnable:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - -
    trackId

    开关对应track -*

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – getBufLength: -

    - -
    -
    - -
    - - -
    -

    查询track中缓存数据的长度（单位为一次输出的samplebuffer数）

    -
    - - - -
    - (int)getBufLength:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - -
    trackId

    开关对应track

    -
    - - - -
    -

    Return Value

    -

    <0, 表示查询失败 - =0，表示残余的数据不足一次输出 - >0, 表示可以buffer中的数据还可以输出n次 -*

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – processAudioSampleBuffer:of: -

    - -
    -
    - -
    - - -
    -

    输入音频PCM

    -
    - - - -
    - (BOOL)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer of:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    sampleBuffer

    音频数据

    trackId

    设置对应track的

    -
    - - - -
    -

    Return Value

    -

    NO为设置失败，比如trackID不存在

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

    – processAudioData:nbSample:withFormat:timeinfo:of: -

    - -
    -
    - -
    - - -
    -

    输入音频PCM

    -
    - - - -
    - (BOOL)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime)pts of:(int)trackId
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    pData

    原始数据指针数组,单通道仅pData[0]有效 当输入为多通道且非交织时, pData[i]分别表示各个通道的数据

    len

    数据的长度，单位为sample (bytes / sizeof(sample))

    fmt

    原始数据的格式

    pts

    原始数据的时间戳

    trackId

    设置对应track的

    -
    - - - -
    -

    Return Value

    -

    NO为设置失败，比如trackID不存在

    -
    - - - - - -
    -

    Discussion

    -

    传入数据为NULL时，仅仅检查是否有数据输出

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 混音后的音频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    请参考 CMSampleBufferRef

    与pcmProcessingCallback两者只能二选一, 设置 audioProcessingCallback 会清空 pcmProcessingCallback

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      pcmProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int nbSample , CMTime pts ) pcmProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    pData 为数据指针 (双通道时, 数据为交织格式), 仅pData[0] 有效

    nbSample 为数据长度, 单位为sample (bytes / sizeof(sample)/channels)

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    与audioProcessingCallback两者只能二选一, 设置 pcmProcessingCallback 会清空audioProcessingCallback

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      mainTrack -

    - -
    -
    - -
    - - -
    -

    主轨的trackId （默认为0）

    -
    - - - -
    @property (nonatomic, assign) int mainTrack
    - - - - - - - - - -
    -

    Discussion

    -

    比如micphone的track，所有track都同步到主轨的时间轴

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      bStereo -

    - -
    -
    - -
    - - -
    -

    输出音频是否为双声道立体声 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL bStereo
    - - - - - - - - - -
    -

    Discussion

    -

    如果输入数据都不是双声道则输出数据左右耳内容一样

    输出立体声的数据格式一定是交织的

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      frameSize -

    - -
    -
    - -
    - - -
    -

    每一次输出数据(Frame)的sample数, 默认为1024

    -
    - - - -
    @property (nonatomic, assign) int frameSize
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      sampleRate -

    - -
    -
    - -
    - - -
    -

    输出音频的采样率, 默认为44100

    -
    - - - -
    @property (nonatomic, assign) int sampleRate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    - -

      outFmtDes -

    - -
    -
    - -
    - - -
    -

    混音后输出PCM的格式

    -
    - - - -
    @property (nonatomic, readonly) AudioStreamBasicDescription *outFmtDes
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYAudioMixer.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYBeautifyFaceFilter.html b/doc/html/Classes/KSYBeautifyFaceFilter.html index 8c1b105..4e8eace 100644 --- a/doc/html/Classes/KSYBeautifyFaceFilter.html +++ b/doc/html/Classes/KSYBeautifyFaceFilter.html @@ -3,11 +3,11 @@ - KSYBeautifyFaceFilter Class Reference + - +
    @@ -43,46 +43,10 @@

    @@ -95,318 +59,15 @@

    -

    KSYBeautifyFaceFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageFilterGroup
    Declared inKSYBeautifyFaceFilter.h
    - - -
    - -

    Overview

    -

    金山云美颜滤镜

    - -

    磨皮 + 美白 + [红润特效]的美颜滤镜 -其中 红润特效为可选效果. -如果启用, 需要依赖外部的KSYGPUResource.bundle中的资源文件 -详细使用方法参见demo

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    init

    -
    - - - -
    - (id)init
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    - -

    + showVersion -

    - -
    -
    - -
    - - -
    -

    show version of this filter

    -
    - - - -
    + (void)showVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    - -

      grindRatio -

    - -
    -
    - -
    - - -
    -

    grindRatio ranges from 0.0 to 1.0, with 0.87 as the normal level

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat grindRatio
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    - -

      whitenRatio -

    - -
    -
    - -
    - - -
    -

    whitenRatio ranges from 0.0 to 1.0, with 0.6 as the normal level

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat whitenRatio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    - -

    – initWithRubbyMaterial: -

    - -
    -
    - -
    - - -
    -

    初始化输入的红润特效素材图像

    -
    - - - -
    - (id)initWithRubbyMaterial:(UIImage *)img
    - - - -
    -

    Parameters

    - - - - - - - -
    img

    红润特效素材文件 (比如KSYGPUResource.bundle中的资源文件)

    -
    - - - -
    -

    Return Value

    -

    构造出来的滤镜

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    - -

      ruddyRatio -

    - -
    -
    - -
    - - -
    -

    ruddyRatio ranges from 0.0 to 1.0, with 1.0 as the normal level, need to use the initWithRubbyMaterial

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat ruddyRatio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyFaceFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYBeautifyProFilter.html b/doc/html/Classes/KSYBeautifyProFilter.html index bd1c3db..4e8eace 100644 --- a/doc/html/Classes/KSYBeautifyProFilter.html +++ b/doc/html/Classes/KSYBeautifyProFilter.html @@ -3,11 +3,11 @@ - KSYBeautifyProFilter Class Reference + - +
    @@ -45,42 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -93,300 +59,15 @@

    -

    KSYBeautifyProFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageFilterGroup
    Declared inKSYBeautifyProFilter.h
    - - -
    - - - - - - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    init

    -
    - - - -
    - (id)init
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    - -

    – initWithIdx: -

    - -
    -
    - -
    - - -
    -

    初始化并指定 1~4 的index来创建对应美颜滤镜

    -
    - - - -
    - (id)initWithIdx:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    效果的索引 (非法值无效)

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    - -

    + showVersion -

    - -
    -
    - -
    - - -
    -

    show version of this filter

    -
    - - - -
    + (void)showVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    - -

      grindRatio -

    - -
    -
    - -
    - - -
    -

    grindRatio ranges from 0.0 to 1.0, with 0.5 as the normal level

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat grindRatio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    - -

      whitenRatio -

    - -
    -
    - -
    - - -
    -

    whitenRatio ranges from 0.0 to 1.0, with 0.3 as the normal level

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat whitenRatio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    - -

      ruddyRatio -

    - -
    -
    - -
    - - -
    -

    ruddyRatio ranges from -1.0 to 1.0, with -0.3 as the normal level

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat ruddyRatio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBeautifyProFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYBgmPlayer.html b/doc/html/Classes/KSYBgmPlayer.html index 3ed3d30..4e8eace 100644 --- a/doc/html/Classes/KSYBgmPlayer.html +++ b/doc/html/Classes/KSYBgmPlayer.html @@ -3,11 +3,11 @@ - KSYBgmPlayer Class Reference + - +
    @@ -43,76 +43,10 @@

    @@ -125,1131 +59,23 @@

    -

    KSYBgmPlayer Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYBgmPlayer.h
    - - -
    - -

    Overview

    -

    背景音乐播放器

    -
    提供背景音乐播放的功能, 并能将被播放的音频数据通过回调送出
-
    -
    - - - -
    - - + +
    - - - -
    -
    - -

    – startPlayBgm:isLoop: -

    - -
    -
    - -
    - - -
    -

    开始播放背景音乐

    -
    - - - -
    - (BOOL)startPlayBgm:(NSString *)path isLoop:(BOOL)loop
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    path

    本地音乐的路径

    loop

    是否循环播放此音乐

    -
    - - - -
    -

    Return Value

    -

    是否能够开始播放

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – stopPlayBgm -

    - -
    -
    - -
    - - -
    -

    停止播放背景音乐

    -
    - - - -
    - (void)stopPlayBgm
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – stopPlayBgm: -

    - -
    -
    - -
    - - -
    -

    停止播放背景音乐 -@param 停止完成的回调函数

    -
    - - - -
    - (void)stopPlayBgm:(void ( ^ ) ( ))completion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – pauseBgm -

    - -
    -
    - -
    - - -
    -

    暂停播放背景音乐

    -
    - - - -
    - (void)pauseBgm
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – resumeBgm -

    - -
    -
    - -
    - - -
    -

    恢复播放背景音乐

    -
    - - - -
    - (void)resumeBgm
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – seekToTime: -

    - -
    -
    - -
    - - -
    -

    seek到指定时间 (拖动进度条)

    -
    - - - -
    - (BOOL)seekToTime:(float)time
    - - - -
    -

    Parameters

    - - - - - - - -
    time

    时间, 请参考 bgmDuration (单位,秒)

    -
    - - - -
    -

    Return Value

    -

    是否seek 成功

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – seekToProgress: -

    - -
    -
    - -
    - - -
    -

    seek到指定进度 (拖动进度条)

    -
    - - - -
    - (BOOL)seekToProgress:(float)prog
    - - - -
    -

    Parameters

    - - - - - - - -
    prog

    进度, 请参考 bgmProgress

    -
    - - - -
    -

    Return Value

    -

    是否seek 成功

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmVolume -

    - -
    -
    - -
    - - -
    -

    背景音乐的音量

    -
    - - - -
    @property (nonatomic, assign) double bgmVolume
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 0.0~1.0

    仅仅调整播放的音量, 不影响回调的音频数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmPitch -

    - -
    -
    - -
    - - -
    -

    播放声音的音调

    -
    - - - -
    @property (nonatomic, assign) double bgmPitch
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 [-24.0 ~ 24.0], 默认为0.01, 单位为半音

    0.01 为1度, 1.0为一个半音, 12个半音为1个八度

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      playRate -

    - -
    -
    - -
    - - -
    -

    播放速率

    -
    - - - -
    @property (nonatomic, assign) double playRate
    - - - - - - - - - -
    -

    Discussion

    -

    调整范围 0.5 ~ 2.0，默认值 1.0

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bMuteBgmPlay -

    - -
    -
    - -
    - - -
    -

    背景音乐播放静音

    -
    - - - -
    @property (nonatomic, assign) BOOL bMuteBgmPlay
    - - - - - - - - - -
    -

    Discussion

    -

    仅仅静音播放, 不影响回调的音频数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      callBackRawData -

    - -
    -
    - -
    - - -
    -

    设置 audioDataBlock 是否返回原始数据

    -
    - - - -
    @property (nonatomic, assign) BOOL callBackRawData
    - - - - - - - - - -
    -

    Discussion

    -

    默认为NO，audioDataBlock 返回的数据为经过变速、变调后的数据 - 如果为YES，audioDataBlock 返回的数据为原始数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      audioDataBlock -

    - -
    -
    - -
    - - -
    -

    音频数据输出回调

    -
    - - - -
    @property (nonatomic, copy) BOOL ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime pts ) audioDataBlock
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 从音乐文件中解码得到的PCM数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmFinishBlock -

    - -
    -
    - -
    - - -
    -

    当背景音乐播放完成时，调用此回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( void ) bgmFinishBlock
    - - - - - - - - - -
    -

    Discussion

    -

    只有设置 loop为NO时才有效, 在开始播放前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmDuration -

    - -
    -
    - -
    - - -
    -

    背景音的duration信息（总时长, 单位:秒）

    -
    - - - -
    @property (nonatomic, readonly) float bgmDuration
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmPlayTime -

    - -
    -
    - -
    - - -
    -

    背景音的已经播放长度 (单位:秒)

    -
    - - - -
    @property (nonatomic, readonly) float bgmPlayTime
    - - - - - - - - - -
    -

    Discussion

    -

    从0开始，最大为bgmDuration长度

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmProcess -

    - -
    -
    - -
    - - -
    -

    音频的播放进度

    -
    - - - -
    @property (nonatomic, readonly) float bgmProcess
    - - - - - - - - - -
    -

    Discussion

    -

    取值从0.0~1.0，大小为bgmPlayTime/bgmDuration;

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      isRunning -

    - -
    -
    - -
    - - -
    -

    音频播放是否运行

    -
    - - - -
    @property (nonatomic, readonly) BOOL isRunning
    - - - - - - - - - -
    -

    Discussion

    -

    音频是否输出到speaker播放

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      audioErrorCode -

    - -
    -
    - -
    - - -
    -

    播放错误码

    -
    - - - -
    @property (nonatomic, readonly) OSStatus audioErrorCode
    - - - - - - - - - -
    -

    Discussion

    -

    播放错误码具体内容可以参考AudioQueue的Apple文档。

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bgmPlayerState -

    - -
    -
    - -
    - - -
    -

    播放状态

    -
    - - - -
    @property (nonatomic, readonly) KSYBgmPlayerState bgmPlayerState
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

      bLoop -

    - -
    -
    - -
    - - -
    -

    单曲循环

    -
    - - - -
    @property (nonatomic, assign) BOOL bLoop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – getBgmStateName: -

    - -
    -
    - -
    - - -
    -

    获取状态对应的字符串

    -
    - - - -
    - (NSString *)getBgmStateName:(KSYBgmPlayerState)stat
    - - - -
    -

    Parameters

    - - - - - - - -
    stat

    状态

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    - -

    – getCurBgmStateName -

    - -
    -
    - -
    - - -
    -

    获取当前状态对应的字符串

    -
    - - - -
    - (NSString *)getCurBgmStateName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmPlayer.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYBgmReader.html b/doc/html/Classes/KSYBgmReader.html index 1127b57..4e8eace 100644 --- a/doc/html/Classes/KSYBgmReader.html +++ b/doc/html/Classes/KSYBgmReader.html @@ -3,11 +3,11 @@ - KSYBgmReader Class Reference + - +
    @@ -43,52 +43,10 @@

    @@ -101,616 +59,15 @@

    -

    KSYBgmReader Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYBgmReader.h
    - - -
    - -

    Overview

    -

    背景音乐文件解码

    - -
    提供背景音乐文件解码的功能,将解码后的音频数据通过回调送出
-输出数据的格式满足如下规律:
 
-* 一定是S16的线性PCM
-* 如果是双通道,一定是交织的数据
-
    -
    - - - - - -
    - - - - - - -
    -
    - -

    – initWithFile:isLoop: -

    - -
    -
    - -
    - - -
    -

    构造音乐文件对应的reader

    -
    - - - -
    - (id)initWithFile:(NSString *)path isLoop:(BOOL)loop
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    path

    本地音乐的路径

    loop

    是否循环播放此音乐

    -
    - - - -
    -

    Return Value

    -

    self

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

    – reloadFile: -

    - -
    -
    - -
    - - -
    -

    reload 一个新的文件到reader中

    -
    - - - -
    - (BOOL)reloadFile:(NSString *)path
    - - - -
    -

    Parameters

    - - - - - - - -
    path

    本地音乐的路径

    -
    - - - -
    -

    Return Value

    -

    path对应的文件是否有效

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

    – closeFile -

    - -
    -
    - -
    - - -
    -

    关闭文件

    -
    - - - -
    - (void)closeFile
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

    – seekTo: -

    - -
    -
    - -
    - - -
    -

    seek到指定时间 (拖动进度条)

    -
    - - - -
    - (BOOL)seekTo:(float)time
    - - - -
    -

    Parameters

    - - - - - - - -
    time

    时间, 请参考 bgmDuration (单位,秒)

    -
    - - - -
    -

    Return Value

    -

    是否seek 成功

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

      bgmFmt -

    - -
    -
    - -
    - - -
    -

    音乐的格式信息 (一定为S16的数据格式)

    -
    - - - -
    @property (nonatomic, readonly) AudioStreamBasicDescription bgmFmt
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

    – readPCMData:nbSample: -

    - -
    -
    - -
    - - -
    -

    从文件中读取一段音频数据 (二选一)

    -
    - - - -
    - (int)readPCMData:(AudioBufferList *)buf nbSample:(UInt32)cnt
    - - - -
    -

    Parameters

    - - - - - - - -
    buf,

    待填充的音频数据 请保证buf.mDataByteSize 先设置为需要读取的字节数

    -
    - - - -
    -

    Return Value

    -

    -1: 解码遇到错误, 请检查音乐文件是否有效 - 0: 文件读取完毕, 无法提供更多数据 (loop时不会返回0) - 1: 读取正常

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

    – readPCMData:capacity: -

    - -
    -
    - -
    - - -
    -

    从文件中读取一段音频数据 (二选一)

    -
    - - - -
    - (int)readPCMData:(void *)buf capacity:(UInt32)cap
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    buf,

    待填充的音频数据(只会输出交织后的数据, 因此只有一个数据指针)

    cap,

    buf的空间大小

    -
    - - - -
    -

    Return Value

    -

    -1: 解码遇到错误, 请检查音乐文件是否有效 - >0: 读取正常, 数值为实际取到的数据字节数

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

      bgmDuration -

    - -
    -
    - -
    - - -
    -

    背景音的duration信息（总时长, 单位:秒）

    -
    - - - -
    @property (nonatomic, readonly) float bgmDuration
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

      bgmPlayTime -

    - -
    -
    - -
    - - -
    -

    背景音的已经播放长度 (单位:秒)

    -
    - - - -
    @property (nonatomic, readonly) float bgmPlayTime
    - - - - - - - - - -
    -

    Discussion

    -

    从0开始，最大为bgmDuration长度

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

      bgmProcess -

    - -
    -
    - -
    - - -
    -

    音频的播放进度

    -
    - - - -
    @property (nonatomic, readonly) float bgmProcess
    - - - - - - - - - -
    -

    Discussion

    -

    取值从0.0~1.0，大小为bgmPlayTime/bgmDuration;

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    - -

      bLoop -

    - -
    -
    - -
    - - -
    -

    单曲循环

    -
    - - - -
    @property (nonatomic, assign) BOOL bLoop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBgmReader.h

    -
    - - -
    -
    -
    -
    - -
    - - -

    diff --git a/doc/html/Classes/KSYBuildInSpecialEffects.html b/doc/html/Classes/KSYBuildInSpecialEffects.html index 478e217..4e8eace 100644 --- a/doc/html/Classes/KSYBuildInSpecialEffects.html +++ b/doc/html/Classes/KSYBuildInSpecialEffects.html @@ -3,11 +3,11 @@ - KSYBuildInSpecialEffects Class Reference + - +
    @@ -43,30 +43,10 @@

    @@ -79,172 +59,15 @@

    -

    KSYBuildInSpecialEffects Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYSpecialEffects : GPUImageFilterGroup
    Declared inKSYBuildInSpecialEffects.h
    - - -
    - -

    Overview

    -

    KSY 特效滤镜

    - -

    内置滤镜需要资源文件支持(KSYResource.bundle) -目前内置了如下6中特效: -1 小清新 -2 靓丽 -3 甜美可人 -4 怀旧 -5 蓝调 -6 老照片 -7 樱花 -8 樱花（光线较暗） -9 红润（光线较暗） -10 阳光（光线较暗） -11 红润 -12 阳光 -13 自然

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – initWithIdx: -

    - -
    -
    - -
    - - -
    -

    初始化并指定 1~13 的index来创建对应效果

    -
    - - - -
    - (id)initWithIdx:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    效果的索引 (非法值无效)

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBuildInSpecialEffects.h

    -
    - - -
    -
    -
    - -

    – setSpecialEffectsIdx: -

    - -
    -
    - -
    - - -
    -

    指定 1~6 的index来创建对应效果

    -
    - - - -
    - (void)setSpecialEffectsIdx:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    效果的索引 (非法值无效)

    -
    - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYBuildInSpecialEffects.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYClipWriter.html b/doc/html/Classes/KSYClipWriter.html index 85c3526..4e8eace 100644 --- a/doc/html/Classes/KSYClipWriter.html +++ b/doc/html/Classes/KSYClipWriter.html @@ -3,11 +3,11 @@ - KSYClipWriter Class Reference + - +
    @@ -43,108 +43,10 @@

    @@ -157,1979 +59,23 @@

    -

    KSYClipWriter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYClipWriter.h
    - - -
    - -

    Overview

    -

    金山云转码SDK iOS版提供了iOS移动设备上的转码合成功能

    - -
      -
    • 音频编码采用AAC编码，码率可配置;
      • -
    • 视频频编码采用H.264、H.265编码，码率可配置;
      • -
    • 支持写入本地flv和mp4文件;
      • -
    - -

    Found: 2017-4-7

    -
    - - - -
    - - + +
    - - - -
    -
    - -

    – getKSYVersion -

    - -
    -
    - -
    - - -
    -

    获取SDK版本号

    -
    - - - -
    - (NSString *)getKSYVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      hostURL -

    - -
    -
    - -
    - - -
    -

    本地录制,输出路径

    -
    - - - -
    @property (nonatomic, readonly) NSURL *hostURL
    - - - - - - - - - -
    -

    Discussion

    -

    将音视频流写入本地文件 -eg: /var/xxxxx/xxx.mp4 /var/xxxxx/xxx.flv

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoFPS -

    - -
    -
    - -
    - - -
    -

    视频帧率

    -
    - - - -
    @property (nonatomic, assign) int videoFPS
    - - - - - - - - - -
    -

    Discussion

    -

    本地录制的视频帧率，开启编码前丢帧时，帧率生效

    编码前丢帧shouldEnableKSYDropModule为YES时，帧率设置生效

    编码前丢帧shouldEnableKSYDropModule为NO时，帧率保持与输入帧率一致

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoCodec -

    - -
    -
    - -
    - - -
    -

    视频编码器 默认为 自动选择

    -
    - - - -
    @property (nonatomic, assign) KSYVideoCodec videoCodec
    - - - - - - - - - -
    -

    Discussion

    -

    video codec used for encode

    修改此选项会导致videoEncodePerf值变化

    如果需要定制编码档次, 请在修改videoCodec之后再测设置

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      audioCodec -

    - -
    -
    - -
    - - -
    -

    音频编码器 (默认为AAC-HE)

    -
    - - - -
    @property (nonatomic, assign) KSYAudioCodec audioCodec
    - - - - - - - - - -
    -

    Discussion

    -

    audio codec used for encode

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoInitBitrate -

    - -
    -
    - -
    - - -
    -

    视频编码码率（单位:kbps, 默认:500）

    -
    - - - -
    @property (nonatomic, assign) int videoInitBitrate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      streamMetaData -

    - -
    -
    - -
    - - -
    -

    写入全局附带的metadata (默认为nil)

    -
    - - - -
    @property (atomic, copy) NSDictionary *streamMetaData
    - - - - - - - - - -
    -

    Discussion

    -

    key 一定要是 NSString* 类型的

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoMetaData -

    - -
    -
    - -
    - - -
    -

    视频流附带的metadata (默认为nil)

    -
    - - - -
    @property (atomic, copy) NSDictionary *videoMetaData
    - - - - - - - - - -
    -

    Discussion

    -

    key 一定要是 NSString* 类型的; 目前有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoCrf -

    - -
    -
    - -
    - - -
    -

    质量等级（默认:20）

    -
    - - - -
    @property (nonatomic, assign) int videoCrf
    - - - - - - - - - -
    -

    Discussion

    -

    视频恒定质量等级，范围0～51，值越小，质量越好

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      maxKeyInterval -

    - -
    -
    - -
    - - -
    -

    最大关键帧间隔（单位:秒, 默认:3）

    -
    - - - -
    @property (nonatomic, assign) float maxKeyInterval
    - - - - - - - - - -
    -

    Discussion

    -

    即GOP长度 画面静止时,隔n秒插入一个关键帧

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      audiokBPS -

    - -
    -
    - -
    - - -
    -

    音频编码码率（单位:kbps）

    -
    - - - -
    @property (nonatomic, assign) int audiokBPS
    - - - - - - - - - -
    -

    Discussion

    -

    音频目标编码码率 (比如48,96,128等)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      liveScene -

    - -
    -
    - -
    - - -
    -

    待编码的视频场景 (默认为KSYLiveScene_Default)

    -
    - - - -
    @property (nonatomic, assign) KSYLiveScene liveScene
    - - - - - - - - - -
    -

    Discussion

    -

    KSY内部会根据场景的特征进行参数调优,开始录制前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      recScene -

    - -
    -
    - -
    - - -
    -

    编码的目标场景 (默认为KSYRecScene_ConstantBitRate)

    -
    - - - -
    @property (nonatomic, assign) KSYRecScene recScene
    - - - - - - - - - -
    -

    Discussion

    -

    开始编码前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoEncodePerf -

    - -
    -
    - -
    - - -
    -

    视频编码性能档次

    -
    - - - -
    @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf
    - - - - - - - - - -
    -

    Discussion

    -

    视频质量和设备资源之间的权衡,开始推流前, videoCodec设置之后,修改有效

    选择软编码的默认为KSYVideoEncodePer_LowPower

    选择Auto或硬编码的默认为KSYVideoEncodePer_HighPerformance

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      bWithVideo -

    - -
    -
    - -
    - - -
    -

    是否处理视频的图像数据 (默认YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bWithVideo
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: 启动合成前设置为NO, 则在转码过程中无法再开启图像

    启动合成前设置为NO, 写入过程中修改本属性无效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      bWithAudio -

    - -
    -
    - -
    - - -
    -

    是否处理音频数据 (默认YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bWithAudio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      writeState -

    - -
    -
    - -
    - - -
    -

    当前写入状态

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamState writeState
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取写入的工作状态

    通知： -* KSYStreamStateDidChangeNotification 当写入工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – getWriteStateName: -

    - -
    -
    - -
    - - -
    -

    获取写入状态对应的字符串

    -
    - - - -
    - (NSString *)getWriteStateName:(KSYStreamState)stat
    - - - -
    -

    Parameters

    - - - - - - - -
    stat

    状态码

    -
    - - - -
    -

    Return Value

    -

    状态名称

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – getCurWriteStateName -

    - -
    -
    - -
    - - -
    -

    获取当前写入状态对应的字符串

    -
    - - - -
    - (NSString *)getCurWriteStateName
    - - - - - -
    -

    Return Value

    -

    当前状态名称

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      streamErrorCode -

    - -
    -
    - -
    - - -
    -

    当前转码/写入的错误码

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取写入失败的原因

    当streamState 为KSYStreamStateError时可查询

    KSYStreamErrorCode_KSYAUTHFAILED 除外

    在streamState 为KSYStreamStateConnected 时查询到

    状态变化后清0

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      writeStateChange -

    - -
    -
    - -
    - - -
    -

    数据流写入状态变化时的回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) writeStateChange
    - - - - - - - - - -
    -

    Discussion

    -

    参数为新状态

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – getKSYWriteErrorCodeName: -

    - -
    -
    - -
    - - -
    -

    获取错误码对应的字符串

    -
    - - - -
    - (NSString *)getKSYWriteErrorCodeName:(KSYStreamErrorCode)code
    - - - -
    -

    Parameters

    - - - - - - - -
    code

    错误码

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – getCurKSYWriteErrorCodeName -

    - -
    -
    - -
    - - -
    -

    获取当前错误码对应的字符串

    -
    - - - -
    - (NSString *)getCurKSYWriteErrorCodeName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      videoFPSChange -

    - -
    -
    - -
    - - -
    -

    帧率应发生变化时的回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange
    - - - - - - - - - -
    -

    Discussion

    -

    参数为建议设定的fps

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – initWithDefaultCfg -

    - -
    -
    - -
    - - -
    -

    初始化方法 （step1）

    -
    - - - -
    - (instancetype)initWithDefaultCfg
    - - - - - - - - - -
    -

    Discussion

    -

    初始化，将下列属性设置为默认值

    - - -

    Warning: KSYClipWriter只支持单实例写入，构造多个实例会出现异常

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – startWritingWith: -

    - -
    -
    - -
    - - -
    -

    启动写入文件 （step2）

    -
    - - - -
    - (void)startWritingWith:(NSURL *)url
    - - - - - - - - - -
    -

    Discussion

    -

    本地写入支持mp4和flv两种输出格式,通过url的文件后缀指定

    “/var/xxx/xx.mp4”, “/var/xxx/xx.flv”

    写入参数主要是视频编码器，音视频码率的设置

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – stopWriting -

    - -
    -
    - -
    - - -
    -

    停止写入 （step3）

    -
    - - - -
    - (void)stopWriting
    - - - - - - - - - -
    -

    Discussion

    -

    停止文件写入

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – stopWriting: -

    - -
    -
    - -
    - - -
    -

    停止写入 （step3）

    -
    - - - -
    - (void)stopWriting:(void ( ^ ) ( ))complete
    - - - -
    -

    Parameters

    - - - - - - - -
    complete

    完成回调

    -
    - - - - - - - -
    -

    Discussion

    -

    停止文件写入

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – muteStream: -

    - -
    -
    - -
    - - -
    -

    静音 (仍然有音频，只是音量为0)

    -
    - - - -
    - (void)muteStream:(BOOL)bMute
    - - - -
    -

    Parameters

    - - - - - - - -
    bMute

    YES / ON

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – processVideoSampleBuffer:onComplete: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    sampleBuffer

    Buffer to process

    completion

    当前视频帧处理完成的回调

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始写入前定期调用此接口，比如按照采集帧率调用

    支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – processVideoPixelBuffer:timeInfo:onComplete: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    pixelBuffer

    待编码的像素数据

    timeStamp

    待编码的时间戳

    completion

    当前视频帧处理完成的回调

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始写入前定期调用此接口，比如按照采集帧率调用

    支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – processAudioSampleBuffer: -

    - -
    -
    - -
    - - -
    -

    处理一段音频数据

    -
    - - - -
    - (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    Buffer to process

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始写入前定期调用此接口，与processVideoSampleBuffer 交错进行

    Warning: 目前只支持 单通道 S16 格式的PCM数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

    – isWriting -

    - -
    -
    - -
    - - -
    -

    查询当前是否处于写入状态 (connecting, 或connected)

    -
    - - - -
    - (BOOL)isWriting
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      encodeVKbps -

    - -
    -
    - -
    - - -
    -

    查询当前编码的视频码率大小（每秒更新）

    -
    - - - -
    @property (nonatomic, readonly) double encodeVKbps
    - - - - - - - - - -
    -

    Discussion

    -

    该码率为编码器产生的视频码率大小，单位为kbps

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      encodeAKbps -

    - -
    -
    - -
    - - -
    -

    查询当前编码的音频码率大小（每秒更新）

    -
    - - - -
    @property (nonatomic, readonly) double encodeAKbps
    - - - - - - - - - -
    -

    Discussion

    -

    该码率为编码器产生的音频码率大小，单位为kbps

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      encodingFPS -

    - -
    -
    - -
    - - -
    -

    查询当前编码的平均视频帧率

    -
    - - - -
    @property (nonatomic, readonly) double encodingFPS
    - - - - - - - - - -
    -

    Discussion

    -

    采集设备的输出帧率为videoFPS，约等于编码的目标帧率

    编码的视频帧率不会高于采集帧率，但是当CPU资源不足时，编码帧率会低于采集帧率

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      encodedFrames -

    - -
    -
    - -
    - - -
    -

    查询本次视频写入已经编码的总帧数

    -
    - - - -
    @property (nonatomic, readonly) int encodedFrames
    - - - - - - - - - -
    -

    Discussion

    -

    从开始写入到现在，编码过的视频总帧数

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      logBlock -

    - -
    -
    - -
    - - -
    -

    clip writer

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
    - - - - - - - - - -
    -

    Discussion

    -

    相关字段说明请联系金山云技术支持

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    - -

      shouldEnableKSYDropModule -

    - -
    -
    - -
    - - -
    -

    是否允许编码前丢帧，默认开启（videoFPS生效） -@warnning 离线转码需要输出所有帧的情况下开启，videoFPS将不生效，根据输入源的fps保持一致

    -
    - - - -
    @property (nonatomic, assign) BOOL shouldEnableKSYDropModule
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYClipWriter.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYDummyAudioSource.html b/doc/html/Classes/KSYDummyAudioSource.html index 1c80cef..4e8eace 100644 --- a/doc/html/Classes/KSYDummyAudioSource.html +++ b/doc/html/Classes/KSYDummyAudioSource.html @@ -3,11 +3,11 @@ - KSYDummyAudioSource Class Reference + - +
    @@ -43,46 +43,10 @@

    @@ -95,437 +59,15 @@

    -

    KSYDummyAudioSource Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYDummyAudioSource.h
    - - -
    - -

    Overview

    -

    静音音频数据源

    -

    和音频采集模块类型能够实时产生音频数据, 但是音量都为0 -主要用于真实音频采集需要被暂停时,用于持续产生音频数据避免中断

    -
    - - - - -
    - - - - - - -
    -
    - -

    – initWithAudioFmt: -

    - -
    -
    - -
    - - -
    -

    构造函数

    -
    - - - -
    - (id)initWithAudioFmt:(AudioStreamBasicDescription)asbd
    - - - -
    -

    Parameters

    - - - - - - - -
    asbd

    输入的音频格式

    -
    - - - -
    -

    Return Value

    -

    新实例

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

    – start -

    - -
    -
    - -
    - - -
    -

    启动产生数据

    -
    - - - -
    - (BOOL)start
    - - - - - -
    -

    Return Value

    -

    是否启动成功

    -
    - - - - - -
    -

    Discussion

    -

    自动生成系统时间戳

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

    – startAt: -

    - -
    -
    - -
    - - -
    -

    启动产生数据

    -
    - - - -
    - (BOOL)startAt:(CMTime)initPts
    - - - -
    -

    Parameters

    - - - - - - - -
    initPts

    设置启动时间戳

    -
    - - - -
    -

    Return Value

    -

    是否启动采集成功

    -
    - - - - - -
    -

    Discussion

    -

    内部都会先将时间戳的timescale转为ns

    -
    - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

    – stop -

    - -
    -
    - -
    - - -
    -

    停止产生数据

    -
    - - - -
    - (void)stop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    静音音频数据输出回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 生成的音频数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

      asbd -

    - -
    -
    - -
    - - -
    -

    format description for audio data -默认PCM格式为: (Float32), 单声道, 44100Hz

    -
    - - - -
    @property (nonatomic, assign) AudioStreamBasicDescription asbd
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

      nbSample -

    - -
    -
    - -
    - - -
    -

    每次尝试产生的数据长度 (sample数, 默认为1024) -实际每次产生的音频的数据长度不确定, 应该是在nbSample附近波动

    -
    - - - -
    @property (nonatomic, assign) int nbSample
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    - -

      bRunning -

    - -
    -
    - -
    - - -
    -

    当前是否正在工作

    -
    - - - -
    @property (nonatomic, readonly) BOOL bRunning
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYDummyAudioSource.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -

    diff --git a/doc/html/Classes/KSYGPUBeautifyExtFilter.html b/doc/html/Classes/KSYGPUBeautifyExtFilter.html index 8d0c384..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBeautifyExtFilter.html +++ b/doc/html/Classes/KSYGPUBeautifyExtFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyExtFilter Class Reference + - +
    @@ -43,28 +43,10 @@

    @@ -77,103 +59,15 @@

    -

    KSYGPUBeautifyExtFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUFilter : GPUImageFilter
    Declared inKSYGPUBeautifyExtFilter.h
    - - -
    - -

    Overview

    -

    扩展增强美颜滤镜

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – setBeautylevel: -

    - -
    -
    - -
    - - -
    -

    美颜的等级

    -
    - - - -
    - (void)setBeautylevel:(int)level
    - - - -
    -

    Parameters

    - - - - - - - -
    level

    1 ~ 5，逐级增强, 默认为3

    -
    - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBeautifyExtFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYGPUBeautifyFilter.html b/doc/html/Classes/KSYGPUBeautifyFilter.html index d702fce..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBeautifyFilter.html +++ b/doc/html/Classes/KSYGPUBeautifyFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyFilter Class Reference + - +
    @@ -43,28 +43,10 @@

    @@ -77,105 +59,15 @@

    -

    KSYGPUBeautifyFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUFilter : GPUImageFilter
    Declared inKSYGPUBeautifyFilter.h
    - - -
    - -

    Overview

    -

    金山云美颜滤镜

    -

    美颜滤镜

    -
    - - - - -
    - - - - - - -
    -
    - -

    – setBeautylevel: -

    -
    -
    - -
    - - -
    -

    美颜的等级

    -
    - - - -
    - (void)setBeautylevel:(int)level
    - - - -
    -

    Parameters

    - - - - - - - -
    level

    1 ~ 5，逐级增强, 默认为3

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBeautifyFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYGPUBeautifyPlusFilter.html b/doc/html/Classes/KSYGPUBeautifyPlusFilter.html index 095671d..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBeautifyPlusFilter.html +++ b/doc/html/Classes/KSYGPUBeautifyPlusFilter.html @@ -3,11 +3,11 @@ - KSYGPUBeautifyPlusFilter Class Reference + - +
    @@ -43,28 +43,10 @@

    @@ -77,103 +59,15 @@

    -

    KSYGPUBeautifyPlusFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUFilter : GPUImageFilter
    Declared inKSYGPUBeautifyPlusFilter.h
    - - -
    - -

    Overview

    -

    增强美颜滤镜

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – setBeautylevel: -

    - -
    -
    - -
    - - -
    -

    美颜的等级

    -
    - - - -
    - (void)setBeautylevel:(int)level
    - - - -
    -

    Parameters

    - - - - - - - -
    level

    1 ~ 5，逐级增强, 默认为3

    -
    - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBeautifyPlusFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYGPUBgmStreamerKit.html b/doc/html/Classes/KSYGPUBgmStreamerKit.html index da6a6ba..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBgmStreamerKit.html +++ b/doc/html/Classes/KSYGPUBgmStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBgmStreamerKit Class Reference + - +
    @@ -45,38 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -89,312 +59,15 @@

    -

    KSYGPUBgmStreamerKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUStreamerKit : NSObject
    Declared inKSYGPUBgmStreamerKit.h
    - - -
    - - - - - - -
    -
    - -

      ksyBgmPlayer -

    - -
    -
    - -
    - - -
    -

    背景音乐播放器

    -
    - - - -
    @property (nonatomic, strong) KSYMoviePlayerController *ksyBgmPlayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    - -

    – startPlayBgm: -

    - -
    -
    - -
    - - -
    -

    开始播放背景音乐

    -
    - - - -
    - (void)startPlayBgm:(NSString *)path
    - - - -
    -

    Parameters

    - - - - - - - -
    path

    背景音乐的路径

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    - -

    – stopPlayBgm -

    - -
    -
    - -
    - - -
    -

    停止播放背景音乐

    -
    - - - -
    - (void)stopPlayBgm
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getBgmStateName: -

    - -
    -
    - -
    - - -
    -

    获取状态对应的字符串

    -
    - - - -
    - (NSString *)getBgmStateName:(MPMoviePlaybackState)stat
    - - - -
    -

    Parameters

    - - - - - - - -
    stat

    状态

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getCurBgmStateName -

    - -
    -
    - -
    - - -
    -

    获取当前状态对应的字符串

    -
    - - - -
    - (NSString *)getCurBgmStateName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    - -

      BgmState -

    - -
    -
    - -
    - - -
    -

    播放状态

    -
    - - - -
    @property (nonatomic, readonly) MPMoviePlaybackState BgmState
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgmStreamerKit.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYGPUBgpStreamerKit.html b/doc/html/Classes/KSYGPUBgpStreamerKit.html index a2ab6c3..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBgpStreamerKit.html +++ b/doc/html/Classes/KSYGPUBgpStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBgpStreamerKit Class Reference + - +
    @@ -45,102 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -153,1716 +59,16 @@

    -

    KSYGPUBgpStreamerKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYGPUBgpStreamerKit.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

    -
    - - -
    -
    -
    - -

      vPreviewMixer -

    - -
    -
    - -
    - - -
    -

    图像混合器 for 预览

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicMixer *vPreviewMixer
    - - - - - - - - - -
    -

    Discussion

    -

    将多图层的内容叠加

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgpStreamerKit.h

    -
    - - -
    -
    -
    - -

      vStreamMixer -

    - -
    -
    - -
    - - -
    -

    图像混合器 for 推流

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicMixer *vStreamMixer
    - - - - - - - - - -
    -

    Discussion

    -

    将多图层的内容叠加

    -
    - - - - - - - -
    -

    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

    -
      -
    1. 通过它来设置推流参数
      2. -
    -
      -
    1. 通过它来启动，停止推流
      2. -
    - -
    - - - - - - - -
    -

    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

    - -
    - - - -
    -

    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: -

    - -
    -
    - -
    - - -
    -

    设置当前使用的滤镜

    -
    - - - -
    - (void)setupFilter:(GPUImageOutput<GPUImageInput> *)filter
    - - - - - - - - - -
    -

    Discussion

    -

    若filter 为nil， 则关闭滤镜

    若filter 为GPUImageFilter的实例，则使用该滤镜做处理

    filter 也可以是GPUImageFilterGroup的实例，可以将多个滤镜组合

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUBgpStreamerKit.h

    -
    - - -
    -
    -
    - -

    – 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

    -
    - - -
    -
    -
    -
    - -
    - - - - - - -
    + +
    diff --git a/doc/html/Classes/KSYGPUBrushStreamerKit.html b/doc/html/Classes/KSYGPUBrushStreamerKit.html index 9a06a77..4e8eace 100644 --- a/doc/html/Classes/KSYGPUBrushStreamerKit.html +++ b/doc/html/Classes/KSYGPUBrushStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUBrushStreamerKit Class Reference + - +
    @@ -45,34 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -85,216 +59,15 @@

    -

    KSYGPUBrushStreamerKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUStreamerKit : NSObject
    Declared inKSYGPUBrushStreamerKit.h
    - - -
    - - - - - - -
    -
    - -

      drawPicRect -

    - -
    -
    - -
    - - -
    -

    绘制图片的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect drawPicRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUBrushStreamerKit.h

    -
    - - -
    -
    -
    - -

      drawLayer -

    - -
    -
    - -
    - - -
    -

    画笔图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger drawLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBrushStreamerKit.h

    -
    - - -
    -
    -
    - -

      drawPic -

    - -
    -
    - -
    - - -
    -

    绘制的图片

    -
    - - - -
    @property (nonatomic, readwrite) KSYGPUViewCapture *drawPic
    - - - - - - - - - -
    -

    Discussion

    -

    设置为nil为清除内容图片

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUBrushStreamerKit.h

    -
    - - -
    -
    -
    - -

    – removeDrawLayer -

    - -
    -
    - -
    - - -
    -

    去掉画笔图层

    -
    - - - -
    - (void)removeDrawLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUBrushStreamerKit.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYGPUCamera.html b/doc/html/Classes/KSYGPUCamera.html index 48ee432..4e8eace 100644 --- a/doc/html/Classes/KSYGPUCamera.html +++ b/doc/html/Classes/KSYGPUCamera.html @@ -3,11 +3,11 @@ - KSYGPUCamera Class Reference + - +
    @@ -43,50 +43,10 @@

    @@ -99,470 +59,15 @@

    -

    KSYGPUCamera Class Reference

    +

    -
    - - - - - - - - - - -
    Inherits fromGPUImageVideoCamera
    Conforms toAVCaptureAudioDataOutputSampleBufferDelegate
    AVCaptureVideoDataOutputSampleBufferDelegate
    Declared inKSYGPUCamera.h
    - - -
    - -

    Overview

    -

    基于 AVFoundation的 音视频采集模块

    -
      -
    • 通过回调将采集的音频和视频数据传出
      • -
    • 将摄像头和音频的常用操作进行封装
      • -
    • 注意: 同时使用AVFoundation的音视频采集, 可能无法使用后台采集的功能
      • -
    • 音频采集为可选项
      • -
    - -
    - - - - -
    - - - - - - -
    -
    - -

    – initWithSessionPreset:cameraPosition: -

    - -
    -
    - -
    - - -
    -

    Begin a capture session

    -
    - - - -
    - (id)initWithSessionPreset:(NSString *)sessionPreset cameraPosition:(AVCaptureDevicePosition)cameraPosition
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    sessionPreset

    Session preset to use

    cameraPosition

    Camera to capture from

    -
    - - - -
    -

    Return Value

    -

    nil 表明cameraPosition对应的sessionPreset不支持，初始化不成功

    -
    - - - - - -
    -

    Discussion

    -

    See AVCaptureSession for acceptable values

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

    – isTorchSupported -

    - -
    -
    - -
    - - -
    -

    当前采集设备是否支持闪光灯

    -
    - - -
    - (BOOL)isTorchSupported
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - -
    -

    Discussion

    -

    通常只有后置摄像头支持闪光灯

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

    – toggleTorch -

    - -
    -
    - -
    - - -
    -

    开关闪光灯

    -
    - - - -
    - (void)toggleTorch
    - - - - - - - - - -
    -

    Discussion

    -

    切换闪光灯的开关状态 开 <–> 关

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

    – setTorchMode: -

    - -
    -
    - -
    - - -
    -

    设置闪光灯

    -
    - - - -
    - (void)setTorchMode:(AVCaptureTorchMode)mode
    - - - -
    -

    Parameters

    - - - - - - - -
    mode

    AVCaptureTorchModeOn/Off

    -
    - - - - - - - -
    -

    Discussion

    -

    设置闪光灯的开关状态

    开始预览后开始有效

    请参考 AVCaptureTorchMode

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

      isRunning -

    - -
    -
    - -
    - - -
    -

    判断是否运行

    -
    - - - -
    @property (readonly, nonatomic) BOOL isRunning
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 原始采集到的音频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题@discussion 请参考 CMSampleBufferRef

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

      videoProcessingCallback -

    - -
    -
    - -
    - - -
    -

    视频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 原始采集到的视频数据

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    - -

    + getCapOrientation: -

    - -
    -
    - -
    - - -
    -

    UIInterfaceOrientation 转 AVCaptureVideoOrientation

    -
    - - - -
    + (AVCaptureVideoOrientation)getCapOrientation:(UIInterfaceOrientation)orien
    - - - -
    -

    Parameters

    - - - - - - - -
    orien

    UI的朝向

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUCamera.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYGPUDnoiseFilter.html b/doc/html/Classes/KSYGPUDnoiseFilter.html index 1633619..4e8eace 100644 --- a/doc/html/Classes/KSYGPUDnoiseFilter.html +++ b/doc/html/Classes/KSYGPUDnoiseFilter.html @@ -3,11 +3,11 @@ - KSYGPUDnoiseFilter Class Reference + - +
    @@ -43,20 +43,10 @@

    @@ -69,37 +59,15 @@

    -

    KSYGPUDnoiseFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUFilter : GPUImageFilter
    Declared inKSYGPUDnoiseFilter.h
    - - -
    - -

    Overview

    -

    去噪滤镜

    -
    - - - - - -
    diff --git a/doc/html/Classes/KSYGPUFilter.html b/doc/html/Classes/KSYGPUFilter.html index c41a5a3..4e8eace 100644 --- a/doc/html/Classes/KSYGPUFilter.html +++ b/doc/html/Classes/KSYGPUFilter.html @@ -3,11 +3,11 @@ - KSYGPUFilter Class Reference + - +
    @@ -43,30 +43,10 @@

    @@ -79,150 +59,15 @@

    -

    KSYGPUFilter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageFilter
    Declared inKSYGPUFilter.h
    - - -
    - -

    Overview

    -

    KSY的滤镜基类

    - -
      -
    1. 继承自GPUImageFilter的基本类
      2. -
    2. 添加了重新载入shader的接口
      3. -
    - -
    - - - -
    - - - - - - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    构造

    -
    - - - -
    - (instancetype)init
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUFilter.h

    -
    - - -
    -
    -
    - -

    – reload: -

    - -
    -
    - -
    - - -
    -

    重新载入纹理shader的代码

    -
    - - - -
    - (void)reload:(NSString *)fragmentShaderString
    - - - -
    -

    Parameters

    - - - - - - - -
    fragmentShaderString

    新的纹理shader的代码

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUFilter.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYGPUPicInput.html b/doc/html/Classes/KSYGPUPicInput.html index 3b6240a..4e8eace 100644 --- a/doc/html/Classes/KSYGPUPicInput.html +++ b/doc/html/Classes/KSYGPUPicInput.html @@ -3,11 +3,11 @@ - KSYGPUPicInput Class Reference + - +
    @@ -43,50 +43,10 @@

    @@ -99,580 +59,15 @@

    -

    KSYGPUPicInput Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageOutput
    Declared inKSYGPUPicInput.h
    - - -
    - -

    Overview

    -

    GPU图像输输入

    - -
      -
    • 将采集到的YUV/RGB数据上传到GPU, 传递给其他filter进行处理
      • -
    • 支持的颜色格式包括: - -
        -
      • kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange: (NV12)
        • -
      • kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:(NV12)
        • -
      • kCVPixelFormatType_420YpCbCr8Planar:(I420)
        • -
      • kCVPixelFormatType_420YpCbCr8PlanarFullRange:(I420)
        • -
      • kCVPixelFormatType_32BGRA:(BGRA)
        • -
      -
      • -
    • 支持图像裁剪
      • -
    • 支持图像旋转
      • -
    - -
    - - - -
    - - - - - - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    Initialization and teardown

    -
    - - - -
    - (id)init
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

    – initWithFmt: -

    - -
    -
    - -
    - - -
    -

    设置输入图像的像素格式

    -
    - - - -
    - (id)initWithFmt:(OSType)fmt
    - - - -
    -

    Parameters

    - - - - - - - -
    fmt

    像素格式

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

      cropRegion -

    - -
    -
    - -
    - - -
    -

    裁剪区域 将输入的图像按照区域裁剪出中间的一块

    -
    - - - -
    @property (readwrite, nonatomic) CGRect cropRegion
    - - - - - - - - - -
    -

    Discussion

    -

    cropRegion 标记了左上角的位置和宽高, 范围都是0.0 到1.0, 非法值无法设置成功

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

    – forceProcessingAtSize: -

    - -
    -
    - -
    - - -
    -

    输出图像的尺寸

    -
    - - - -
    - (void)forceProcessingAtSize:(CGSize)frameSize
    - - - - - - - - - -
    -

    Discussion

    -

    设置了裁剪区域, 并且改变了宽高比后, 需要调用此接口, 否则图像可能变形

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

      outputSize -

    - -
    -
    - -
    - - -
    -

    实际输出图像的尺寸

    -
    - - - -
    @property (nonatomic) CGSize outputSize
    - - - - - - - - - -
    -

    Discussion

    -

    forceProcessingAtSize: 也是对outputSize属性进行赋值

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

      outputRotation -

    - -
    -
    - -
    - - -
    -

    输出画面的朝向

    -
    - - - -
    @property (nonatomic, assign) GPUImageRotationMode outputRotation
    - - - - - - - - - -
    -

    Discussion

    -

    输出的画面旋转90度的整数倍, 默认为 kGPUImageNoRotation

    直接连接到KSYGPUPicMixer时, 旋转90度的情况可能出现问题, 请尽量保证中间有其他滤镜

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

      alwaysDiscardsLateVideoFrames -

    - -
    -
    - -
    - - -
    -

    是否允许超时丢帧

    -
    - - - -
    @property (nonatomic, assign) BOOL alwaysDiscardsLateVideoFrames
    - - - - - - - - - -
    -

    Discussion

    -

    当video frame处理超时时，该属性为YES时，将丢弃新的video frame，为NO时将等待处理完毕的信号。

    默认为YES。

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

    – processSampleBuffer: -

    - -
    -
    - -
    - - -
    -

    输入图像数据

    -
    - - - -
    - (void)processSampleBuffer:(CMSampleBufferRef)sampleBuffer
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    图像数据和时间信息

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

    – processPixelBuffer:time: -

    - -
    -
    - -
    - - -
    -

    输入图像数据

    -
    - - - -
    - (void)processPixelBuffer:(CVPixelBufferRef)pixelBuffer time:(CMTime)timeInfo
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    pixelBuffer

    图像数据

    timeInfo

    时间信息

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    - -

    – processPixelData:format:width:height:stride:time: -

    - -
    -
    - -
    - - -
    -

    输入图像数据

    -
    - - - -
    - (void)processPixelData:(void **)pData format:(OSType)pixelFmt width:(size_t)width height:(size_t)height stride:(size_t *)strides time:(CMTime)timeInfo
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
    pData

    图像数据每个分量的指针, 比如pData[0]为Y分量的指针

    pixelFmt

    图像数据类型, 必须与init时指定的格式一致

    width

    图像宽度

    height

    图像高度

    strides

    图像数据每个分量的行偏移, 比如 stride[0] 为Y分量的行偏移

    timeInfo

    时间信息

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicInput.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYGPUPicMixer.html b/doc/html/Classes/KSYGPUPicMixer.html index f38321b..4e8eace 100644 --- a/doc/html/Classes/KSYGPUPicMixer.html +++ b/doc/html/Classes/KSYGPUPicMixer.html @@ -3,11 +3,11 @@ - KSYGPUPicMixer Class Reference + - +
    @@ -43,50 +43,10 @@

    @@ -99,627 +59,15 @@

    -

    KSYGPUPicMixer Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageFilter
    Declared inKSYGPUPicMixer.h
    - - -
    - -

    Overview

    -

    图像混合filter

    - -
      -
    • 将多个图层的内容进行叠加
      • -
    • 每个图层有index, [0~n]
      • -
    • 叠加顺序为0在最下层, index 越大在更上层
      • -
    • 可以每个图层分别指定位置和大小
      • -
    • 可以每个图层分别制定透明度
      • -
    • 可以动态交换图层
      • -
    • 可以动态刷新图层内容(支持视频)
      • -
    • 输出的刷新率 与 masterLayer 保持一致
      • -
    - -
    - - - - - -
    - - - - - - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    初始化

    -
    - - - -
    - (id)init
    - - - - - - - - - -
    -

    Discussion

    -

    输出大小等于主要图层的大小

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – initWithOutputSize: -

    - -
    -
    - -
    - - -
    -

    初始化,并制定输出图像的大小

    -
    - - - -
    - (id)initWithOutputSize:(CGSize)sz
    - - - -
    -

    Parameters

    - - - - - - - -
    sz

    输出图像的大小

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

      masterLayer -

    - -
    -
    - -
    - - -
    -

    设置主要图层 (默认为0)

    -
    - - - -
    @property (nonatomic, assign) NSUInteger masterLayer
    - - - - - - - - - -
    -

    Discussion

    -

    主要图层一般为视频图层, 当主要图层的输入刷新时, 输出才刷新

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – setPicRect:ofLayer: -

    - -
    -
    - -
    - - -
    -

    设置图层的位置和大小 (单位为: 像素值 或者百分比)

    -
    - - - -
    - (void)setPicRect:(CGRect)rect ofLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    rect

    大小和位置

    idx

    图层的索引

    -
    - - - - - - - -
    -

    Discussion

    -

    缩放变形到对应的位置, 数值有如下两种表示方式 - - 像素值:rect中宽度或高度的值必须大于1.0, 则认为是像素值 - - 百分比:rect中宽度或高度的值必须小于等于1.0, 则认为是对应输出图像大小的百分比

    保持宽高比的设置方法 - - 宽为0, 则按照高度和输入图像的宽高比计算出宽度 - - 高为0, 则按照宽度和输入图像的宽高比计算出高度

    左上角的位置如果为非负值,则和宽高一样;如果为负数, 则自动居中放置

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – getPicRectOfLayer: -

    - -
    -
    - -
    - - -
    -

    获取图层的位置和大小 (单位为: 像素值 或者百分比)

    -
    - - - -
    - (CGRect)getPicRectOfLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    图层的索引

    -
    - - - -
    -

    Return Value

    -

    位置和大小

    -
    - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – setPicAlpha:ofLayer: -

    - -
    -
    - -
    - - -
    -

    设置图层的透明度 (默认为1.0)

    -
    - - - -
    - (void)setPicAlpha:(CGFloat)alpha ofLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    alpha

    透明度(0~1.0), 0为全透明

    idx

    图层的索引

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – getPicAlphaOfLayer: -

    - -
    -
    - -
    - - -
    -

    获取图层的透明度

    -
    - - - -
    - (CGFloat)getPicAlphaOfLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    图层的索引

    -
    - - - -
    -

    Return Value

    -

    透明度

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – setPicRotation:ofLayer: -

    - -
    -
    - -
    - - -
    -

    设置图层的旋转 (默认为norotation)

    -
    - - - -
    - (void)setPicRotation:(GPUImageRotationMode)rotation ofLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    rotation

    透明度(0~1.0), 0为全透明

    idx

    图层的索引

    -
    - - - - - - - -
    -

    Discussion

    -

    可用于设置镜像 (kGPUImageFlipHorizonal)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – getPicRotationOfLayer: -

    - -
    -
    - -
    - - -
    -

    获取图层的旋转模式

    -
    - - - -
    - (GPUImageRotationMode)getPicRotationOfLayer:(NSInteger)idx
    - - - -
    -

    Parameters

    - - - - - - - -
    idx

    图层的索引

    -
    - - - -
    -

    Return Value

    -

    旋转模式

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    - -

    – clearPicOfLayer: -

    - -
    -
    - -
    - - -
    -

    清除特定图层的画面内容

    -
    - - - -
    - (void)clearPicOfLayer:(NSInteger)index
    - - - -
    -

    Parameters

    - - - - - - - -
    index

    指定被清除的图层

    -
    - - - - - - - -
    -

    Discussion

    -

    比如切换不同的视频内容时，避免出现黑色背景

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicMixer.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYGPUPicOutput.html b/doc/html/Classes/KSYGPUPicOutput.html index 2555689..4e8eace 100644 --- a/doc/html/Classes/KSYGPUPicOutput.html +++ b/doc/html/Classes/KSYGPUPicOutput.html @@ -3,11 +3,11 @@ - KSYGPUPicOutput Class Reference + - +
    @@ -43,54 +43,10 @@

    @@ -103,641 +59,15 @@

    -

    KSYGPUPicOutput Class Reference

    +

    -
    - - - - - - - - - - -
    Inherits fromNSObject
    Conforms toGPUImageInput
    Declared inKSYGPUPicOutput.h
    - - -
    - -

    Overview

    -

    GPU图像输出

    - -

    从GPU中取得处理后的图像, 通过回调函数将pixelBuffer和时间戳送出

    - -
      -
    • 本模块含有一个GPUImageInput的接口, 从其他filter接收渲染结果
      • -
    • 通过inputSize 查询输入的图像尺寸
      • -
    • 通过outputSize 设置输出的图像尺寸
      • -
    • 通过cropRegion 设置裁剪区域
      • -
    • 初始化时可指定输出数据的像素格式
      • -
    • 支持的输出颜色格式包括: - -
        -
      • kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange: (NV12)
        • -
      • kCVPixelFormatType_420YpCbCr8BiPlanarFullRange:(NV12)
        • -
      • kCVPixelFormatType_420YpCbCr8Planar:(I420)
        • -
      • kCVPixelFormatType_420YpCbCr8PlanarFullRange:(I420)
        • -
      • kCVPixelFormatType_32BGRA:(BGRA)
        • -
      • kCVPixelFormatType_4444AYpCbCr8:(AYUV) 排列顺序为 (A Y' Cb Cr)
        • -
      -
      • -
    -
    - - - - - -
    - - - - -

    Initialization

    - -
    -
    - -

    – init -

    - -
    -
    - -
    - - -
    -

    初始化方法

    -
    - - - -
    - (id)init
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

    – initWithOutFmt: -

    - -
    -
    - -
    - - -
    -

    指定输出格式的初始化

    -
    - - - -
    - (id)initWithOutFmt:(OSType)fmt
    - - - -
    -

    Parameters

    - - - - - - - -
    fmt

    输出格式

    -
    - - - - - - - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    -
    - - - -

    query and settings

    - -
    -
    - -

      outputPixelFormat -

    - -
    -
    - -
    - - -
    -

    output format (默认:kCVPixelFormatType_32BGRA)

    -
    - - - -
    @property (nonatomic, readonly) OSType outputPixelFormat
    - - - - - - - - - -
    -

    Discussion

    -

    非法颜色格式都会被当做 kCVPixelFormatType_32BGRA 处理

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      enabled -

    - -
    -
    - -
    - - -
    -

    GPUImageInput - (BOOL)enabled;

    -
    - - - -
    @property (nonatomic) BOOL enabled
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      bCustomOutputSize -

    - -
    -
    - -
    - - -
    -

    是否使用自定义输出尺寸 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL bCustomOutputSize
    - - - - - - - - - -
    -

    Discussion

    -

    NO: outputSize自动跟随输入图像的变化而变化

    YES: outputSize使用外部自定义设置,忽略输入尺寸

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      outputSize -

    - -
    -
    - -
    - - -
    -

    output picture size

    -
    - - - -
    @property (nonatomic, assign) CGSize outputSize
    - - - - - - - - - -
    -

    Discussion

    -

    当bCustomOutputSize设置为NO时,outputSize无法被修改

    可以对裁剪后的图像再进行缩放

    输出尺寸必须为4的整数倍, 内部会进行向上取整

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      cropRegion -

    - -
    -
    - -
    - - -
    -

    裁剪区域 将输入的图像按照区域裁剪出中间的一块

    -
    - - - -
    @property (readwrite, nonatomic) CGRect cropRegion
    - - - - - - - - - -
    -

    Discussion

    -

    cropRegion 标记了左上角的位置和宽高, 范围都是0.0 到1.0

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      inputSize -

    - -
    -
    - -
    - - -
    -

    input picture size

    -
    - - - -
    @property (nonatomic, readonly) CGSize inputSize
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      bAutoRepeat -

    - -
    -
    - -
    - - -
    -

    是否冻结图像(主动提供重复图像)

    -
    - - - -
    @property (nonatomic, readwrite) BOOL bAutoRepeat
    - - - - - - - - - -
    -

    Discussion

    -

    比如:视频采集被打断时, bAutoRepeat为NO,则停止提供图像; 为YES, 则主动提供最后一帧图像

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      targetFps -

    - -
    -
    - -
    - - -
    -

    0表示根据过去输入的图像来猜测帧率, 1~30 表示按照设定的帧率提供重复的帧, 默认为0

    -
    - - - -
    @property (nonatomic, readwrite) int targetFps
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

    – getInputRotation -

    - -
    -
    - -
    - - -
    -

    input roation mode

    -
    - - - -
    - (GPUImageRotationMode)getInputRotation
    - - - - - -
    -

    Return Value

    -

    图像的旋转模式

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    - -

      videoProcessingCallback -

    - -
    -
    - -
    - - -
    -

    视频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CVPixelBufferRef pixelBuffer , CMTime timeInfo ) videoProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    pixelBuffer 美颜处理后，编码之前的视频数据

    timeInfo 时间戳 -@warnning 请注意本函数的执行时间，如果太长可能导致不可预知的问题

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPicOutput.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYGPUPipStreamerKit.html b/doc/html/Classes/KSYGPUPipStreamerKit.html index 5c1924f..4e8eace 100644 --- a/doc/html/Classes/KSYGPUPipStreamerKit.html +++ b/doc/html/Classes/KSYGPUPipStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUPipStreamerKit Class Reference + - +
    @@ -45,54 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -105,651 +59,15 @@

    -

    KSYGPUPipStreamerKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUStreamerKit : NSObject
    Declared inKSYGPUPipStreamerKit.h
    - - -
    - - - - - - -
    -
    - -

      pipTrack -

    - -
    -
    - -
    - - -
    -

    画中画通道

    -
    - - -
    @property (nonatomic, readonly) int pipTrack
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      bgPicLayer -

    - -
    -
    - -
    - - -
    -

    背景图片图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger bgPicLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      pipLayer -

    - -
    -
    - -
    - - -
    -

    画中画图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger pipLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

    – startPipWithPlayerUrl:bgPic: -

    - -
    -
    - -
    - - -
    -

    开启画中画 -@param playerUrl:播放视频的url -@param bgUrl:背景图片的url

    -
    - - - -
    - (void)startPipWithPlayerUrl:(NSURL *_Nullable)playerUrl bgPic:(NSURL *_Nullable)bgUrl
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

    – stopPip -

    - -
    -
    - -
    - - -
    -

    停止画中画 -*

    -
    - - - -
    - (void)stopPip
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      player -

    - -
    -
    - -
    - - -
    -

    背景播放器

    -
    - - - -
    @property (nonatomic, readonly) KSYMoviePlayerController *player
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      bgPic -

    - -
    -
    - -
    - - -
    -

    背景图片

    -
    - - - -
    @property (nonatomic, strong) GPUImagePicture *bgPic
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      yuvInput -

    - -
    -
    - -
    - - -
    -

    画中画图像输入

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicInput *yuvInput
    - - - - - - - - - -
    -

    Discussion

    -

    用于衔接画中画播放器和图像混合器 (KSYPicPipLayer = 1)

    主要用于将图像的原始数据上传到GPU

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      bgPicRect -

    - -
    -
    - -
    - - -
    -

    背景图片的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect bgPicRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      pipRect -

    - -
    -
    - -
    - - -
    -

    画中画的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect pipRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      cameraRect -

    - -
    -
    - -
    - - -
    -

    相机的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect cameraRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getPipStateName: -

    - -
    -
    - -
    - - -
    -

    获取状态对应的字符串

    -
    - - - -
    - (NSString *_Nonnull)getPipStateName:(MPMoviePlaybackState)stat
    - - - -
    -

    Parameters

    - - - - - - - -
    stat

    状态

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getCurPipStateName -

    - -
    -
    - -
    - - -
    -

    获取当前状态对应的字符串

    -
    - - - -
    - (NSString *_Nonnull)getCurPipStateName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    - -

      PipState -

    - -
    -
    - -
    - - -
    -

    播放状态

    -
    - - - -
    @property (nonatomic, readonly) MPMoviePlaybackState PipState
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUPipStreamerKit.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYGPUStreamerKit.html b/doc/html/Classes/KSYGPUStreamerKit.html index 93cd0ea..4e8eace 100644 --- a/doc/html/Classes/KSYGPUStreamerKit.html +++ b/doc/html/Classes/KSYGPUStreamerKit.html @@ -3,11 +3,11 @@ - KSYGPUStreamerKit Class Reference + - +
    @@ -43,182 +43,10 @@

    @@ -231,3662 +59,23 @@

    -

    KSYGPUStreamerKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYGPUStreamerKit.h
    - - -
    - -

    Overview

    -

    KSY 直播推流工具类

    - -
      -
    • kit类将直播推流SDK中提供的各种组件进行组合串联, 功能覆盖了绝大部分秀场直播场景的需求
      • -
    • 可以直接使用Kit类来开发基础功能的推流APP
      • -

    • 亦可以参考kit类的代码, 了解每个组件API的使用方法, 自行开发进阶需求的功能

      • -

    • 本 kit 类中, 演示了3个图层内容和2个音频通道的叠加直播

      • -

    • 图像通道: ([]中的数字为图层编号) -vCapDev –> cropFilter –> filters[0] –>| vPreMixer |-> preview - logo picture[1] –>| - logo text label[2] –>| vStrMixer |-> picOutput –> streamer

      • -

    • 音频通道: ([]中的数字为音轨编号) - aCapDev [0] –>| -bgmplayer [1] –>| aMixer –> streamer

      • -
    -
    - - - -
    - - + +
    - - - -
    -
    - -

    – initWithDefaultCfg -

    - -
    -
    - -
    - - -
    -

    初始化方法

    -
    - - - -
    - (instancetype)initWithDefaultCfg
    - - - - - - - - - -
    -

    Discussion

    -

    创建带有默认参数的 kit，不会打断其他后台的音乐播放

    Warning: kit只支持单实例推流，构造多个实例会出现异常

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – initWithInterruptCfg -

    - -
    -
    - -
    - - -
    -

    初始化方法

    -
    - - - -
    - (instancetype)initWithInterruptCfg
    - - - - - - - - - -
    -

    Discussion

    -

    创建带有默认参数的 kit，会打断其他后台的音乐播放

    Warning: kit只支持单实例推流，构造多个实例会出现异常

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getKSYVersion -

    - -
    -
    - -
    - - -
    -

    获取SDK版本号

    -
    - - - -
    - (NSString *)getKSYVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      vCapDev -

    - -
    -
    - -
    - - -
    -

    视频采集设备

    -
    - - - -
    @property (nonatomic, readonly) KSYAVFCapture *vCapDev
    - - - - - - - - - -
    -

    Discussion

    -

    通过该指针可以对摄像头进行操作 (操作接口参见GPUImage)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      filter -

    - -
    -
    - -
    - - -
    -

    获取当前使用的滤镜

    -
    - - - -
    @property (nonatomic, readonly) GPUImageOutput<GPUImageInput> *filter
    - - - - - - - - - -
    -

    Discussion

    -

    通过此指针可以对滤镜参数进行设置 -@waning 请确保外部保留了filter的真实类型的指针, 否则会出现奔溃

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      vPreviewMixer -

    - -
    -
    - -
    - - -
    -

    图像混合器 for 预览

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicMixer *vPreviewMixer
    - - - - - - - - - -
    -

    Discussion

    -

    将多图层的内容叠加

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      vStreamMixer -

    - -
    -
    - -
    - - -
    -

    图像混合器 for 推流

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicMixer *vStreamMixer
    - - - - - - - - - -
    -

    Discussion

    -

    将多图层的内容叠加

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      preview -

    - -
    -
    - -
    - - -
    -

    预览视图

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUView *preview
    - - - - - - - - - -
    -

    Discussion

    -

    通过此指针可以对预览视图进行操作

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      capToGpu -

    - -
    -
    - -
    - - -
    -

    采集到的图像上传GPU

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicInput *capToGpu
    - - - - - - - - - -
    -

    Discussion

    -

    用于衔接GPU和capture

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      gpuToStr -

    - -
    -
    - -
    - - -
    -

    获取渲染的图像

    -
    - - - -
    @property (nonatomic, readonly) KSYGPUPicOutput *gpuToStr
    - - - - - - - - - -
    -

    Discussion

    -

    用于衔接GPU和streamer

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      aCapDev -

    - -
    -
    - -
    - - -
    -

    音频采集设备 Audio Unit 音频采集

    -
    - - - -
    @property (nonatomic, readonly) KSYAUAudioCapture *aCapDev
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      bgmPlayer -

    - -
    -
    - -
    - - -
    -

    背景音乐播放器

    -
    - - - -
    @property (nonatomic, readonly) KSYBgmPlayer *bgmPlayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      aMixer -

    - -
    -
    - -
    - - -
    -

    音频混合器

    -
    - - - -
    @property (nonatomic, readonly) KSYAudioMixer *aMixer
    - - - - - - - - - -
    -

    Discussion

    -

    用于将多路音频进行混合,将混合后的音频送入streamerBase

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      audioCaptureType -

    - -
    -
    - -
    - - -
    -

    音频采集模式

    -
    - - - -
    @property (nonatomic, assign) KSYAudioCapType audioCaptureType
    - - - - - - - - - -
    -

    Discussion

    -

    推荐使用AudioUnit模式

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      msgStreamer -

    - -
    -
    - -
    - - -
    -

    消息通道

    -
    - - - -
    @property (nonatomic, readonly) KSYMessage *msgStreamer
    - - - - - - - - - -
    -

    Discussion

    -

    用于采集消息，并将数据送入streamerBase

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamerBase -

    - -
    -
    - -
    - - -
    -

    获取初始化时创建的底层推流工具

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamerBase *streamerBase
    - - - - - - - - - -
    -

    Discussion

    -
      -
    1. 通过它来设置推流参数
      2. -
    -
      -
    1. 通过它来启动，停止推流
      2. -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      maxAutoRetry -

    - -
    -
    - -
    - - -
    -

    自动重连次数 关闭(0), 开启(>0), 默认为0

    -
    - - - -
    @property (nonatomic, assign) int maxAutoRetry
    - - - - - - - - - -
    -

    Discussion

    -

    当内部发现推流错误后, 会在一段时间后尝试重连 -自动重连不会重新获取推流地址, 仍然使用上次推流的地址

    Warning: 如果在推流地址有过期时间, 请勿开启

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      autoRetryDelay -

    - -
    -
    - -
    - - -
    -

    自动重连延时, 发现连接错误后, 重试的延时

    -
    - - - -
    @property (nonatomic, assign) double autoRetryDelay
    - - - - - - - - - -
    -

    Discussion

    -

    单位为秒, 默认为2s, 最小值为0.1s

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      cameraLayer -

    - -
    -
    - -
    - - -
    -

    摄像头图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger cameraLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      logoPicLayer -

    - -
    -
    - -
    - - -
    -

    logo 图片的图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger logoPicLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      logoTxtLayer -

    - -
    -
    - -
    - - -
    -

    logo 文字的图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger logoTxtLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      aeLayer -

    - -
    -
    - -
    - - -
    -

    贴纸的图层

    -
    - - - -
    @property (nonatomic, readonly) NSInteger aeLayer
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      micTrack -

    - -
    -
    - -
    - - -
    -

    麦克风通道

    -
    - - - -
    @property (nonatomic, readonly) int micTrack
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      bgmTrack -

    - -
    -
    - -
    - - -
    -

    背景音乐通道

    -
    - - - -
    @property (nonatomic, readonly) int bgmTrack
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      captureState -

    - -
    -
    - -
    - - -
    -

    当前采集设备状况

    -
    - - - -
    @property (nonatomic, readonly) KSYCaptureState captureState
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取采集设备的工作状况

    通知： -* KSYCaptureStateDidChangeNotification 当采集设备工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getCaptureStateName: -

    - -
    -
    - -
    - - -
    -

    获取采集状态对应的字符串

    -
    - - - -
    - (NSString *)getCaptureStateName:(KSYCaptureState)stat
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getCurCaptureStateName -

    - -
    -
    - -
    - - -
    -

    获取当前采集状态对应的字符串

    -
    - - - -
    - (NSString *)getCurCaptureStateName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – startPreview: -

    - -
    -
    - -
    - - -
    -

    启动预览

    -
    - - - -
    - (void)startPreview:(UIView *)view
    - - - -
    -

    Parameters

    - - - - - - - -
    view

    预览画面作为subview，插入到 view 的最底层

    -
    - - - - - - - -
    -

    Discussion

    -

    设置完成采集参数之后，按照设置值启动预览，启动后对采集参数修改不会生效

    需要访问摄像头和麦克风的权限，若授权失败，其他API都会拒绝服务

    - -

    @warning: 开始推流前必须先启动预览

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – startVideoCap -

    - -
    -
    - -
    - - -
    -

    开启视频配置和采集

    -
    - - - -
    - (BOOL)startVideoCap
    - - - - - - - - - -
    -

    Discussion

    -

    设置完成视频采集参数之后，按照设置值启动视频预览，启动后对视频采集参数修改不会生效

    需要访问摄像头的权限，若授权失败，其他API都会拒绝服务

    视频采集成功返回YES，不成功返回NO

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – startAudioCap -

    - -
    -
    - -
    - - -
    -

    开始音频配置和采集

    -
    - - - -
    - (BOOL)startAudioCap
    - - - - - - - - - -
    -

    Discussion

    -

    设置完成音频采集参数之后，按照设置值启动音频预览，启动后对音频采集参数修改不会生效

    需要访问麦克风的权限，若授权失败，其他API都会拒绝服务

    音频采集成功返回YES，不成功返回NO

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – stopPreview -

    - -
    -
    - -
    - - -
    -

    停止预览，停止采集设备，并清理会话

    -
    - - - -
    - (void)stopPreview
    - - - - - - - - - -
    -

    Discussion

    -

    若推流未结束，则先停止推流

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – appEnterBackground -

    - -
    -
    - -
    - - -
    -

    进入后台: 暂停图像采集

    -
    - - - -
    - (void)appEnterBackground
    - - - - - - - - - -
    -

    Discussion

    -

    暂停图像采集和预览, 中断旁路录制

    如果需要释放mic资源请直接调用停止采集

    kit内部在收到UIApplicationDidEnterBackgroundNotification 或采集被打断等事件时,会主动调用本接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – appBecomeActive -

    - -
    -
    - -
    - - -
    -

    回到前台: 恢复采集

    -
    - - - -
    - (void)appBecomeActive
    - - - - - - - - - -
    -

    Discussion

    -

    恢复图像采集和预览

    恢复音频采集

    kit内部在收到UIApplicationDidBecomeActiveNotification等事件时,会主动调用本接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      capPreset -

    - -
    -
    - -
    - - -
    -

    采集分辨率 (仅在开始采集前设置有效)

    -
    - - - -
    @property (nonatomic, assign) NSString *capPreset
    - - - - - - - - - -
    -

    Discussion

    -

    参见iOS的 AVCaptureSessionPresetXXX的定义

    https://developer.apple.com/reference/avfoundation/avcapturesession/1669314-video_input_presets?language=objc

    透传到 KSYGPUCamera. 默认值为AVCaptureSessionPreset640x480

    不同设备支持的预设分辨率可能不同, 请尽量与预览分辨率一致

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – captureDimension -

    - -
    -
    - -
    - - -
    -

    查询实际的采集分辨率

    -
    - - - -
    - (CGSize)captureDimension
    - - - - - - - - - -
    -

    Discussion

    -

    参见iOS的 AVCaptureSessionPresetXXX的定义

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      previewDimension -

    - -
    -
    - -
    - - -
    -

    预览分辨率 (仅在开始采集前设置有效)

    -
    - - - -
    @property (nonatomic, assign) CGSize previewDimension
    - - - - - - - - - -
    -

    Discussion

    -

    内部始终将较大的值作为宽度 (若需要竖屏，请设置 videoOrientation）

    宽高都会向上取整为4的整数倍

    有效范围: 宽度[160, 1920] 高度[ 90, 1080], 超出范围会取边界有效值

    当预览分辨率与采集分辨率不一致时: - 若宽高比不同, 先进行裁剪, 再进行缩放 - 若宽高比相同, 直接进行缩放

    默认值为(640, 360)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamDimension -

    - -
    -
    - -
    - - -
    -

    用户定义的视频 推流 分辨率

    -
    - - - -
    @property (nonatomic, assign) CGSize streamDimension
    - - - - - - - - - -
    -

    Discussion

    -

    有效范围: 宽度[160, 1280] 高度[ 90, 720], 超出范围会取边界有效值

    其他与previewDimension限定一致,

    当与previewDimension不一致时, 同样先裁剪到相同宽高比, 再进行缩放

    默认值为(640, 360)

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      capturePixelFormat -

    - -
    -
    - -
    - - -
    -

    采集模块输出的像素格式 (默认:kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange)

    -
    - - - -
    @property (nonatomic, assign) OSType capturePixelFormat
    - - - - - - - - - -
    -

    Discussion

    -

    目前只支持 kCVPixelFormatType_32BGRA 和 kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange

    仅在开始推流前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      gpuOutputPixelFormat -

    - -
    -
    - -
    - - -
    -

    gpu output pixel format (默认:kCVPixelFormatType_32BGRA)

    -
    - - - -
    @property (nonatomic, assign) OSType gpuOutputPixelFormat
    - - - - - - - - - -
    -

    Discussion

    -

    目前支持 BGRA , NV12 和 I420

    仅在开始推流前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      videoFPS -

    - -
    -
    - -
    - - -
    -

    采集及编码视频帧率 (开始采集前设置有效)

    -
    - - - -
    @property (nonatomic, assign) int videoFPS
    - - - - - - - - - -
    -

    Discussion

    -

    video frame per seconds 有效范围[1~30], 超出范围会取边界有效值

    默认值为15

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      cameraPosition -

    - -
    -
    - -
    - - -
    -

    摄像头位置 (仅在开始采集前设置有效)

    -
    - - - -
    @property (nonatomic, assign) AVCaptureDevicePosition cameraPosition
    - - - - - - - - - -
    -

    Discussion

    -

    前后摄像头, 默认值为前置

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      videoOrientation -

    - -
    -
    - -
    - - -
    -

    摄像头朝向, 只在启动采集前设置有效

    -
    - - - -
    @property (nonatomic, readwrite) UIInterfaceOrientation videoOrientation
    - - - - - - - - - -
    -

    Discussion

    -

    参见UIInterfaceOrientation

    竖屏时: width < height

    横屏时: width > height

    需要与UI方向一致

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      bStereoAudioStream -

    - -
    -
    - -
    - - -
    -

    是否用双声道推流 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL bStereoAudioStream
    - - - - - - - - - -
    -

    Discussion

    -

    使用KSYAUAudioCapture采集的声音目前只支持单声道(主播说话的声音为单声道)

    背景音乐如果是双声道的音频,通过修改bStereoStream, 可以让观众听到双声道的音乐

    只能在开始推流前修改本属性, 开始推流后, 修改无效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – switchCamera -

    - -
    -
    - -
    - - -
    -

    切换摄像头

    -
    - - - -
    - (BOOL)switchCamera
    - - - - - -
    -

    Return Value

    -

    TRUE: 成功切换摄像头， FALSE：当前参数，下一个摄像头不支持，切换失败

    -
    - - - - - -
    -

    Discussion

    -

    在前后摄像头间切换，从当前的摄像头切换到另一个，切换成功则修改cameraPosition的值

    开始预览后开始有效，推流过程中也响应切换请求

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – isTorchSupported -

    - -
    -
    - -
    - - -
    -

    当前采集设备是否支持闪光灯

    -
    - - - -
    - (BOOL)isTorchSupported
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - -
    -

    Discussion

    -

    通常只有后置摄像头支持闪光灯

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – toggleTorch -

    - -
    -
    - -
    - - -
    -

    开关闪光灯

    -
    - - - -
    - (void)toggleTorch
    - - - - - - - - - -
    -

    Discussion

    -

    切换闪光灯的开关状态 开 <–> 关

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – setTorchMode: -

    - -
    -
    - -
    - - -
    -

    设置闪光灯

    -
    - - - -
    - (void)setTorchMode:(AVCaptureTorchMode)mode
    - - - -
    -

    Parameters

    - - - - - - - -
    mode

    AVCaptureTorchModeOn/Off

    -
    - - - - - - - -
    -

    Discussion

    -

    设置闪光灯的开关状态

    开始预览后开始有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – getCurrentCameraDevices -

    - -
    -
    - -
    - - -
    -

    获取当前采集设备的指针

    -
    - - - -
    - (AVCaptureDevice *)getCurrentCameraDevices
    - - - - - -
    -

    Return Value

    -

    AVCaptureDevice* 预览开始前调用返回为nil，开始预览后，返回当前正在使用的摄像头

    -
    - - - - - -
    -

    Discussion

    -

    开放本指针的目的是开放类似下列添加到AVCaptureDevice的 categories： -- AVCaptureDeviceFlash -- AVCaptureDeviceTorch -- AVCaptureDeviceFocus -- AVCaptureDeviceExposure -- AVCaptureDeviceWhiteBalance -- etc.

    Warning: 请勿修改摄像头的像素格式，帧率，分辨率等参数，修改后会导致推流工作异常或崩溃

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      videoProcessingCallback -

    - -
    -
    - -
    - - -
    -

    视频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) videoProcessingCallback
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    原始采集到的视频数据

    -
    - - - - - - - -
    -

    Discussion

    -

    对sampleBuffer内的图像数据的修改将传递到观众端

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    请参考 CMSampleBufferRef

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      audioProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( CMSampleBufferRef sampleBuffer ) audioProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    sampleBuffer 原始采集到的音频数据

    对sampleBuffer内的pcm数据的修改将传递到观众端

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    当audioDataType 为KSYAudioData_CMSampleBuffer时才会被触发回调

    请参考 CMSampleBufferRef

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      pcmProcessingCallback -

    - -
    -
    - -
    - - -
    -

    音频处理回调接口

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( uint8_t **pData , int len , const AudioStreamBasicDescription *fmt , CMTime timeInfo ) pcmProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    pData len为原始采集到的音频数据

    当audioDataType 为KSYAudioData_RawPCM时才会被触发回调

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      audioDataType -

    - -
    -
    - -
    - - -
    -

    音频处理通路数据类型 (默认为 KSYAudioData_CMSampleBuffer)

    -
    - - - -
    @property (nonatomic, assign) KSYAudioDataType audioDataType
    - - - - - - - - - -
    -

    Discussion

    -

    音频数据转为 CMSampleBuffer时有格式开销, 使用RawPCM资源消耗会少一些

    内部组件对KSYAudioData_RawPCM可能不完善, 目前仅保证基本通路能工作

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      interruptCallback -

    - -
    -
    - -
    - - -
    -

    摄像头采集被打断的消息通知

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( BOOL bInterrupt ) interruptCallback
    - - - - - - - - - -
    -

    Discussion

    -

    bInterrupt 为YES, 表明被打断, 摄像头采集暂停

    bInterrupt 为NO, 表明恢复采集

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – setupFilter: -

    - -
    -
    - -
    - - -
    -

    设置当前使用的滤镜

    -
    - - - -
    - (void)setupFilter:(GPUImageOutput<GPUImageInput> *)filter
    - - - - - - - - - -
    -

    Discussion

    -

    若filter 为nil， 则关闭滤镜

    若filter 为GPUImageFilter的实例，则使用该滤镜做处理

    filter 也可以是GPUImageFilterGroup的实例，可以将多个滤镜组合

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      previewMirrored -

    - -
    -
    - -
    - - -
    -

    预览设置成镜像模式，默认为NO

    -
    - - - -
    @property (nonatomic, assign) BOOL previewMirrored
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamerMirrored -

    - -
    -
    - -
    - - -
    -

    推流设置成镜像模式,默认为NO

    -
    - - - -
    @property (nonatomic, assign) BOOL streamerMirrored
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamerFreezed -

    - -
    -
    - -
    - - -
    -

    推流的画面是否冻结 (默认为NO)

    -
    - - - -
    @property (nonatomic, assign) BOOL streamerFreezed
    - - - - - - - - - -
    -

    Discussion

    -

    通过本属性可以主动将推流的画面固定为当前帧

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      previewOrientation -

    - -
    -
    - -
    - - -
    -

    预览图像朝向, 如果UI能够旋转,需要保持和UI的朝向一致

    -
    - - - -
    @property (nonatomic, assign) UIInterfaceOrientation previewOrientation
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamOrientation -

    - -
    -
    - -
    - - -
    -

    推流图像朝向, 如果UI能够旋转, 可以跟随旋转,也可以不修改

    -
    - - - -
    @property (nonatomic, assign) UIInterfaceOrientation streamOrientation
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – rotatePreviewTo: -

    - -
    -
    - -
    - - -
    -

    根据UI的朝向旋转预览视图, 保证预览视图全屏铺满窗口

    -
    - - - -
    - (void)rotatePreviewTo:(UIInterfaceOrientation)orie
    - - - -
    -

    Parameters

    - - - - - - - -
    orie

    旋转到目标朝向, 需要从demo中获取UI的朝向传入

    -
    - - - - - - - -
    -

    Discussion

    -

    采集到的图像的朝向还是和启动时的朝向一致

    此函数与 previewOrientation的set函数功能一样

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – rotateStreamTo: -

    - -
    -
    - -
    - - -
    -

    根据UI的朝向旋转推流画面, 这个是可以选的,可以不跟随旋转

    -
    - - - -
    - (void)rotateStreamTo:(UIInterfaceOrientation)orie
    - - - -
    -

    Parameters

    - - - - - - - -
    orie

    旋转到目标朝向, 需要从demo中获取UI的朝向传入

    -
    - - - - - - - -
    -

    Discussion

    -

    此函数与 streamOrientation 的set函数功能一样

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      logoPic -

    - -
    -
    - -
    - - -
    -

    水印logo的图片

    -
    - - - -
    @property (nonatomic, readwrite) GPUImagePicture *logoPic
    - - - - - - - - - -
    -

    Discussion

    -

    设置为nil为清除水印图片

    请注意背景图片的尺寸, 太大的图片会导致内存占用过高

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – setLogoOrientaion: -

    - -
    -
    - -
    - - -
    -

    设置水印图片的朝向

    -
    - - - -
    - (void)setLogoOrientaion:(UIImageOrientation)orien
    - - - -
    -

    Parameters

    - - - - - - - -
    orien

    图片的朝向

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      textPic -

    - -
    -
    - -
    - - -
    -

    文字内容的图片

    -
    - - - -
    @property (nonatomic, readwrite) GPUImagePicture *textPic
    - - - - - - - - - -
    -

    Discussion

    -

    设置为nil为清除内容图片

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      aePic -

    - -
    -
    - -
    - - -
    -

    贴纸的图片

    -
    - - - -
    @property (nonatomic, readwrite) GPUImageUIElement *aePic
    - - - - - - - - - -
    -

    Discussion

    -

    设置为nil为清除贴纸图片

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      logoRect -

    - -
    -
    - -
    - - -
    -

    水印logo的图片的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect logoRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      logoAlpha -

    - -
    -
    - -
    - - -
    -

    水印logo的图片的位置

    -
    - - - -
    @property (nonatomic, readwrite) CGFloat logoAlpha
    - - - - - - - - - -
    -

    Discussion

    -

    alpha为透明度(0-1),0完全透明，1完全不透明

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      textLabel -

    - -
    -
    - -
    - - -
    -

    水印文字的label

    -
    - - - -
    @property (nonatomic, readwrite) UILabel *textLabel
    - - - - - - - - - -
    -

    Discussion

    -

    借用UILabel来指定文字的颜色,字体, 透明度, 对齐方式等属性

    请注意保证背景图片的尺寸, 太大的图片会导致内存占用过高

    Warning: 如果使用非等宽字体, 可能导致闪烁(默认为Courier)

    Warning: picMixer和UILabel都有alpha属性, 建议只选用其中一个, 固定另一个为1.0, - 为了减少接口, 建议直接使用UILabel的属性, - 如果两者同时使用, 最终图层的alpha为两者乘积

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      textRect -

    - -
    -
    - -
    - - -
    -

    水印文字的图片的位置和大小

    -
    - - - -
    @property (nonatomic, readwrite) CGRect textRect
    - - - - - - - - - -
    -

    Discussion

    -

    位置和大小的单位为预览视图的百分比, 左上角为(0,0), 右下角为(1.0, 1.0)

    如果宽为0, 则根据文字图像的宽高比, 和设置的高度比例, 计算得到宽度的比例

    如果高为0, 方法同上

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – updateTextLabel -

    - -
    -
    - -
    - - -
    -

    刷新水印文字的内容

    -
    - - - -
    - (void)updateTextLabel
    - - - - - - - - - -
    -

    Discussion

    -

    先修改文字的内容或格式,调用该方法后生效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – focusAtPoint: -

    - -
    -
    - -
    - - -
    -

    当前采集设备是否支持自动变焦 -@param point相机对焦的位置

    -
    - - - -
    - (BOOL)focusAtPoint:(CGPoint)point
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - -
    -

    Discussion

    -

    通常只有后置摄像头支持自动变焦

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – exposureAtPoint: -

    - -
    -
    - -
    - - -
    -

    当前采集设备是否支持自动曝光 -@param point相机曝光的位置

    -
    - - - -
    - (BOOL)exposureAtPoint:(CGPoint)point
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - -
    -

    Discussion

    -

    通常前后置摄像头都支持自动曝光

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      pinchZoomFactor -

    - -
    -
    - -
    - - -
    -

    触摸缩放因子

    -
    - - - -
    @property (nonatomic, assign) CGFloat pinchZoomFactor
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      streamerProfile -

    - -
    -
    - -
    - - -
    -

    采集和推流配置参数

    -
    - - - -
    @property (nonatomic, assign) KSYStreamerProfile streamerProfile
    - - - - - - - - - -
    -

    Discussion

    -

    选择profile类型后, 采集和编码参数会自动配置进去, 默认的profile类型是KSYStreamerProfile_540p_3

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

      stabilizationMode -

    - -
    -
    - -
    - - -
    -

    摄像头防抖模式，切换摄像头后需要进行重新设置

    -
    - - - -
    @property (nonatomic, assign) AVCaptureVideoStabilizationMode stabilizationMode
    - - - - - - - - - -
    -

    Discussion

    -

    (iPhone前置摄像头不支持防抖功能)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    - -

    – processMessageData: -

    - -
    -
    - -
    - - -
    -

    用户待发送的消息 -@param messageData待发送的消息

    -
    - - - -
    - (BOOL)processMessageData:(NSDictionary *)messageData
    - - - - - -
    -

    Return Value

    -

    YES / NO

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUStreamerKit.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYGPUView.html b/doc/html/Classes/KSYGPUView.html index 8841655..4e8eace 100644 --- a/doc/html/Classes/KSYGPUView.html +++ b/doc/html/Classes/KSYGPUView.html @@ -3,11 +3,11 @@ - KSYGPUView Class Reference + - +
    @@ -43,40 +43,10 @@

    @@ -89,285 +59,15 @@

    -

    KSYGPUView Class Reference

    +

    -
    - - - - - - - - - - -
    Inherits fromUIView
    Conforms toGPUImageInput
    Declared inKSYGPUView.h
    - - -
    - -

    Overview

    -

    UIView subclass to use as an endpoint for displaying GPUImage outputs

    -
    - - - -
    - - - - - - -
    -
    - -

      fillMode -

    - -
    -
    - -
    - - -
    -

    画面填充模式, 默认值为kGPUImageFillModePreserveAspectRatio

    -
    - - - -
    @property (readwrite, nonatomic) GPUImageFillModeType fillMode
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUView.h

    -
    - - -
    -
    -
    - -

      sizeInPixels -

    - -
    -
    - -
    - - -
    -

    This calculates the current display size, in pixels, taking into account Retina scaling factors

    -
    - - - -
    @property (readonly, nonatomic) CGSize sizeInPixels
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUView.h

    -
    - - -
    -
    -
    - -

      enabled -

    - -
    -
    - -
    - - -
    -

    GPUImageInput 启用

    -
    - - - -
    @property (nonatomic) BOOL enabled
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUView.h

    -
    - - -
    -
    -
    - -

    – setBackgroundColorRed:green:blue:alpha: -

    - -
    -
    - -
    - - -
    -

    Handling fill mode

    -
    - - - -
    - (void)setBackgroundColorRed:(GLfloat)redComponent green:(GLfloat)greenComponent blue:(GLfloat)blueComponent alpha:(GLfloat)alphaComponent
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - -
    redComponent

    Red component for background color

    greenComponent

    Green component for background color

    blueComponent

    Blue component for background color

    alphaComponent

    Alpha component for background color

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUView.h

    -
    - - -
    -
    -
    - -

    – setCurrentlyReceivingMonochromeInput: -

    - -
    -
    - -
    - - -
    -

    是否接收单通道输入

    -
    - - - -
    - (void)setCurrentlyReceivingMonochromeInput:(BOOL)newValue
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUView.h

    -
    - - -
    -
    -
    -
    - -
    - - - -

    diff --git a/doc/html/Classes/KSYGPUViewCapture.html b/doc/html/Classes/KSYGPUViewCapture.html index 71c3bdf..4e8eace 100644 --- a/doc/html/Classes/KSYGPUViewCapture.html +++ b/doc/html/Classes/KSYGPUViewCapture.html @@ -3,11 +3,11 @@ - KSYGPUViewCapture Class Reference + - +
    @@ -43,50 +43,10 @@

    @@ -99,488 +59,15 @@

    -

    KSYGPUViewCapture Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageOutput
    Declared inKSYGPUViewCapture.h
    - - -
    - -

    Overview

    -

    GPU UIView视图 采集模块

    - -
      -
    • 采集UIView视图的内容到GPU
      • -
    • 内部使用 CADisplayLink 作为timer 驱动画面更新
      • -
    • 可通过属性设置更新频率
      • -
    -
    - - - - - -
    - - - - - - -
    -
    - -

    – initWithView: -

    - -
    -
    - -
    - - -
    -

    设置需要采集的视图

    -
    - - - -
    - (id)initWithView:(UIView *)inputView
    - - - -
    -

    Parameters

    - - - - - - - -
    inputView

    被采集的视图

    -
    - - - -
    -

    Return Value

    -

    采集实例

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – initWithLayer: -

    - -
    -
    - -
    - - -
    -

    设置需要采集的视图图层

    -
    - - - -
    - (id)initWithLayer:(CALayer *)inputLayer
    - - - -
    -

    Parameters

    - - - - - - - -
    inputLayer

    被采集的图层

    -
    - - - -
    -

    Return Value

    -

    采集实例

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – layerSizeInPixels -

    - -
    -
    - -
    - - -
    - (CGSize)layerSizeInPixels
    - - -
    -
    -
    - -

    – update -

    - -
    -
    - -
    - - -
    -

    更新画面内容 使用无效时间戳

    -
    - - - -
    - (void)update
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – updateUsingCurrentTime -

    - -
    -
    - -
    - - -
    -

    更新画面内容 使用当前时间戳

    -
    - - - -
    - (void)updateUsingCurrentTime
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – updateWithTimestamp: -

    - -
    -
    - -
    - - -
    -

    更新画面内容

    -
    - - - -
    - (void)updateWithTimestamp:(CMTime)frameTime
    - - - -
    -

    Parameters

    - - - - - - - -
    frameTime

    时间戳

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

      updateFps -

    - -
    -
    - -
    - - -
    -

    UI刷新的频率 默认值为15 (有效值fps=60/N, 比如60, 30, 20, 15, 10等)

    -
    - - - -
    @property int updateFps
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – start -

    - -
    -
    - -
    - - -
    -

    启动采集

    -
    - - - -
    - (void)start
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

    – stop -

    - -
    -
    - -
    - - -
    -

    停止采集

    -
    - - - -
    - (void)stop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    - -

      paused -

    - -
    -
    - -
    - - -
    -

    暂停 / 继续

    -
    - - - -
    @property BOOL paused
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYGPUViewCapture.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYGPUYUVInput.html b/doc/html/Classes/KSYGPUYUVInput.html index 7dbdbd3..4e8eace 100644 --- a/doc/html/Classes/KSYGPUYUVInput.html +++ b/doc/html/Classes/KSYGPUYUVInput.html @@ -3,11 +3,11 @@ - KSYGPUYUVInput Class Reference + - +
    @@ -43,20 +43,10 @@

    @@ -69,38 +59,15 @@

    -

    KSYGPUYUVInput Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYGPUPicInput : GPUImageOutput
    Declared inKSYGPUPicInput.h
    - - -
    - -

    Overview

    -

    GPU图像输输入 -过期的类, 请使用KSYGPUPicInput

    -
    - - - - - -
    diff --git a/doc/html/Classes/KSYMediaInfo.html b/doc/html/Classes/KSYMediaInfo.html index e7527bc..4e8eace 100644 --- a/doc/html/Classes/KSYMediaInfo.html +++ b/doc/html/Classes/KSYMediaInfo.html @@ -3,11 +3,11 @@ - KSYMediaInfo Class Reference + - +
    @@ -43,36 +43,10 @@

    @@ -85,255 +59,15 @@

    -

    KSYMediaInfo Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYMediaInfo.h
    - - -
    - -

    Overview

    -

    媒体信息

    -
    - - - - - -
    - - - - - - -
    -
    - -

      type -

    - -
    -
    - -
    - - -
    -

    封装格式，具体类型为MEDIAINFO_MUX_TYPE

    -
    - - - -
    @property (nonatomic) MEDIAINFO_MUX_TYPE type
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      bitrate -

    - -
    -
    - -
    - - -
    -

    码率

    -
    - - - -
    @property (nonatomic, assign) int64_t bitrate
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      duration -

    - -
    -
    - -
    - - -
    -

    视频总时长，单位是秒

    -
    - - - -
    @property (nonatomic, assign) NSTimeInterval duration
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      videos -

    - -
    -
    - -
    - - -
    -

    所有视频流信息，具体对象类型为KSYVideoInfo

    -
    - - - -
    @property (nonatomic) NSMutableArray *videos
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      audios -

    - -
    -
    - -
    - - -
    -

    所有音频流信息，具体对象类型为KSYAudioInfo

    -
    - - - -
    @property (nonatomic) NSMutableArray *audios
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYMediaInfoProber.html b/doc/html/Classes/KSYMediaInfoProber.html index 6549700..4e8eace 100644 --- a/doc/html/Classes/KSYMediaInfoProber.html +++ b/doc/html/Classes/KSYMediaInfoProber.html @@ -3,11 +3,11 @@ - KSYMediaInfoProber Class Reference + - +
    @@ -43,52 +43,10 @@

    @@ -101,617 +59,15 @@

    -

    KSYMediaInfoProber Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYMediaInfoProber.h
    - - -
    - -

    Overview

    -

    KSYMediaInfoProber

    -
    - - - -
    - - - - - - -
    -
    - -

    – initWithContentURL: -

    - -
    -
    - -
    - - -
    -

    初始化文件格式探测器并设置播放地址

    -
    - - - -
    - (instancetype)initWithContentURL:(NSURL *)url
    - - - -
    -

    Parameters

    - - - - - - - -
    url

    待探测格式的文件地址，该地址可以是本地地址或者服务器地址.

    -
    - - - -
    -

    Return Value

    -

    返回KSYMediaInfoProber对象

    -
    - - - - - -
    -

    Discussion

    -

    Warning: 必须调用该方法进行初始化，不能调用init方法。

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      timeout -

    - -
    -
    - -
    - - -
    -

    文件格式探测时间，单位是秒，默认值是3秒

    -
    - - - -
    @property (nonatomic) NSTimeInterval timeout
    - - - - - - - - - -
    -

    Discussion

    -

    超过该时间未探测到文件格式时，直接返回

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      bAccelerate -

    - -
    -
    - -
    - - -
    -

    是否要加速探测速度

    -
    - - - -
    @property (nonatomic) BOOL bAccelerate
    - - - - - - - - - -
    -

    Discussion

    -

    加速后，探测格式可能不完整，默认不加速

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

    – setHttpHeaders: -

    - -
    -
    - -
    - - -
    -

    发送http请求时需要header带上的字段

    -
    - - - -
    - (void)setHttpHeaders:(NSDictionary *)headers
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.0 and later.

    -
    - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      url -

    - -
    -
    - -
    - - -
    -

    待探测的文件格式地址

    -
    - - - -
    @property (nonatomic, copy) NSURL *url
    - - - - - - - - - -
    -

    Discussion

    -

    可不释放KSYMediaInfoProber实例，通过设置contentURL来完成下一次探测

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      bH264Codec -

    - -
    -
    - -
    - - -
    -

    编码类型是否是h264

    -
    - - - -
    @property (nonatomic, readonly) BOOL bH264Codec
    - - - - - - - - - -
    -

    Discussion

    -

    获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      bHEVCCodec -

    - -
    -
    - -
    - - -
    -

    编码类型是否是hevc

    -
    - - - -
    @property (nonatomic, readonly) BOOL bHEVCCodec
    - - - - - - - - - -
    -

    Discussion

    -

    获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      bAACCodec -

    - -
    -
    - -
    - - -
    -

    编码类型是否是aac

    -
    - - - -
    @property (nonatomic, readonly) BOOL bAACCodec
    - - - - - - - - - -
    -

    Discussion

    -

    获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      bMP3Codec -

    - -
    -
    - -
    - - -
    -

    编码类型是否是mp3

    -
    - - - -
    @property (nonatomic, readonly) BOOL bMP3Codec
    - - - - - - - - - -
    -

    Discussion

    -

    获取此属性前至少要调用一次[ksyMediaInfo]，方可得到正确的结果

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

      ksyMediaInfo -

    - -
    -
    - -
    - - -
    -

    媒体信息, 具体对象类型为KSYMediaInfo

    -
    - - - -
    @property (nonatomic, strong) KSYMediaInfo *ksyMediaInfo
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.3 and later.

    -
    - - - -
    -

    Discussion

    -

    未探测到文件格式时为nil

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    - -

    – getVideoThumbnailImageAtTime:width:height: -

    - -
    -
    - -
    - - -
    -

    获取视频缩略图

    -
    - - - -
    - (UIImage *)getVideoThumbnailImageAtTime:(NSTimeInterval)seekTime width:(int)width height:(int)height
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    seekTime

    指定的时间位置，单位为s, 小于0时无法截图

    width

    缩略图的宽度

    height

    缩略图的高度

    -
    - - - -
    -

    Return Value

    -

    返回UIImage对象，即为缩略图

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.8.2 and later.

    -
    - - - -
    -

    Discussion

    -

    缩略图宽度和高度说明

    - -
      -
    • 指定缩略图宽度和高度都为0时，输出的缩略图与原视频中的宽高相同
      • -
    • 指定缩略图宽度不为0，高度为0时，高度会根据原视频的宽高比例做出缩放
      • -
    • 指定缩略图高度不为0，宽度为0时，宽度会根据原视频的宽高比例作出缩放
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfoProber.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYMessage.html b/doc/html/Classes/KSYMessage.html index ff06702..4e8eace 100644 --- a/doc/html/Classes/KSYMessage.html +++ b/doc/html/Classes/KSYMessage.html @@ -3,11 +3,11 @@ - KSYMessage Class Reference + - +
    @@ -45,30 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - @@ -81,131 +59,15 @@

    -

    KSYMessage Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYMessage.h
    - - -
    - - - - - - -
    -
    - -

    – processMessageData: -

    - -
    -
    - -
    - - -
    -

    处理消息数据 -@param 消息数据

    -
    - - - -
    - (BOOL)processMessageData:(NSMutableDictionary *)messageData
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMessage.h

    -
    - - -
    -
    -
    - -

      messageProcessingCallback -

    - -
    -
    - -
    - - -
    -

    消息处理回调接口 -@param 消息数据

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( NSDictionary *messageData ) messageProcessingCallback
    - - - - - - - - - -
    -

    Discussion

    -

    请注意本函数的执行时间，如果太长可能导致不可预知的问题

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMessage.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYMoviePlayerController.html b/doc/html/Classes/KSYMoviePlayerController.html index 6aceb5b..4e8eace 100644 --- a/doc/html/Classes/KSYMoviePlayerController.html +++ b/doc/html/Classes/KSYMoviePlayerController.html @@ -3,11 +3,11 @@ - KSYMoviePlayerController Class Reference + - +
    @@ -43,154 +43,10 @@

    @@ -203,3709 +59,16 @@

    -

    KSYMoviePlayerController Class Reference

    +

    -
    - - - - - - - - - - -
    Inherits fromNSObject
    Conforms toKSYMediaPlayback
    Declared inKSYMoviePlayerController.h
    - - -
    - -

    Overview

    -

    KSYMoviePlayerController

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – initWithContentURL: -

    - -
    -
    - -
    - - -
    -

    初始化播放器并设置播放地址

    -
    - - - -
    - (instancetype)initWithContentURL:(NSURL *)url
    - - - -
    -

    Parameters

    - - - - - - - -
    url

    视频播放地址，该地址可以是本地地址或者服务器地址.

    -
    - - - -
    -

    Return Value

    -

    返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

    返回KSYMoviePlayerController 实例

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    该方法初始化了播放器，并设置了播放地址。但是并没有将播放器对视频文件进行初始化，需要调用 prepareToPlay方法对视频文件进行初始化。

    当前支持的协议包括：

    - -
      -
    • http
      • -
    • rtmp
      • -
    • file, 本地文件
      • -
    • rtsp
      • -
    -

    Warning: 必须调用该方法进行初始化，不能调用init方法。

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – initWithContentURL:sharegroup: -

    - -
    -
    - -
    - - -
    -

    初始化播放器并设置播放地址

    -
    - - - -
    - (instancetype)initWithContentURL:(NSURL *)url sharegroup:(EAGLSharegroup *)sharegroup
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    url

    视频播放地址，该地址可以是本地地址或者服务器地址.

    sharegroup

    opengl的sharegroup, 用于共享视频渲染texture

    -
    - - - -
    -

    Return Value

    -

    返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.8.7 and later.

    -
    - - - -
    -

    Discussion

    -

    如果要获取视频渲染时的texture时(设置textureBlock属性)，需要使用此初始化函数，将EAGLSharegroup对象作为参数传入，否则texture无法在多个OpenGL的context中共享使用

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – initWithContentURL:fileList:sharegroup: -

    - -
    -
    - -
    - - -
    -

    初始化播放器并设置播放地址

    -
    - - - -
    - (instancetype)initWithContentURL:(NSURL *)url fileList:(NSArray *)fileList sharegroup:(EAGLSharegroup *)sharegroup
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    url

    视频播放的绝对地址，可以设置为nil;

    sharegroup

    opengl的sharegroup, 用于共享视频渲染texture, 可以设置为nil

    list

    分片列表，可以设置为nil

    -
    - - - -
    -

    Return Value

    -

    返回KSYMoviePlayerController对象，该对象的视频播放地址ContentURL已经初始化。此时播放器状态为MPMoviePlaybackStateStopped.

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    该方法更适用于点播

    url和list的设置逻辑:

    - -
      -
    • url和fileList不能同时为空
      • -
    • url为nil，fileList不为nil时，播放器取list中的地址进行播放
      • -
    • url不nil，fileList为nil时，播放器取baseURL进行播放
      • -
    • url和fileList都不为nil，播放会认为url是绝对地址，list为相对地址，找到url中的最后一个'/‘进行url/list 拼接后播放
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      contentURL -

    - -
    -
    -
    - - -
    -

    正在播放的视频文件的URL地址，该地址可以是本地地址或者服务器地址。

    -
    - - - -
    @property (nonatomic, readonly) NSURL *contentURL
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      fileList -

    - -
    -
    - -
    - - -
    -

    正在播放的视频文件的list列表

    -
    - - - -
    @property (nonatomic, readonly) NSArray *fileList
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.0 and later.

    -
    - - - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      view -

    - -
    -
    - -
    - - -
    -

    包含视频播放内容的VIEW（只读）。

    -
    - - - -
    @property (nonatomic, readonly) UIView *view
    - - - - - - - - - -
    -

    Discussion

    -

    view的使用逻辑：

    - -
      -
    • 可以通过frame设置view大大小
      • -
    • 使用scalingMode 可以更改视频内容在VIEW中的显示情况
      • -
    - -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      controlStyle -

    - -
    -
    - -
    - - -
    -

    该属性当前不支持

    -
    - - - -
    @property (nonatomic) MPMovieControlStyle controlStyle
    - - - - - - - - -
    -

    Discussion

    -

    Warning: 该属性当前不支持

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      playbackState -

    - -
    -
    - -
    - - -
    -

    当前播放器的播放状态（只读）。

    -
    - - - -
    @property (nonatomic, readonly) MPMoviePlaybackState playbackState
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    可以通过该属性获取视频播放情况：

    - -
    
-typedef NS_ENUM(NSInteger, MPMoviePlaybackState) {
-MPMoviePlaybackStateStopped,           // 播放停止
-MPMoviePlaybackStatePlaying,           // 正在播放
-MPMoviePlaybackStatePaused,            // 播放暂停
-MPMoviePlaybackStateInterrupted,       // 播放被打断
-MPMoviePlaybackStateSeekingForward,    // 向前seeking中
-MPMoviePlaybackStateSeekingBackward    // 向后seeking中
-} NS_DEPRECATED_IOS(3_2, 9_0);
-
    -

    通知：

    - -
      -
    • MPMoviePlayerPlaybackDidFinishNotification，当播放完成时提供通知
      • -
    • MPMoviePlayerPlaybackStateDidChangeNotification，当播放状态变化时提供通知
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      loadState -

    - -
    -
    - -
    - - -
    -

    当前网络加载情况

    -
    - - - -
    @property (nonatomic, readonly) MPMovieLoadState loadState
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    可以通过该属性获取视频加载情况：

    - -
    
-typedef NS_OPTIONS(NSUInteger, MPMovieLoadState) {
-MPMovieLoadStateUnknown        = 0,        // 加载情况未知
-MPMovieLoadStatePlayable       = 1 << 0,   // 加载完成，可以播放
-MPMovieLoadStatePlaythroughOK  = 1 << 1,   // 加载完成，如果shouldAutoplay为YES，将自动开始播放
-MPMovieLoadStateStalled        = 1 << 2,   // 如果视频正在加载中
-} NS_DEPRECATED_IOS(3_2, 9_0);
-
    -

    通知：

    - -
      -
    • MPMoviePlayerLoadStateDidChangeNotification，当加载状态变化时提供通知
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldAutoplay -

    - -
    -
    - -
    - - -
    -

    播放视频时是否需要自动播放，默认值为YES。

    -
    - - - -
    @property (nonatomic) BOOL shouldAutoplay
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      scalingMode -

    - -
    -
    - -
    - - -
    -

    当前缩放显示模式。

    -
    - - - -
    @property (nonatomic) MPMovieScalingMode scalingMode
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    当前支持四种缩放模式：

    - -
    
-typedef NS_ENUM(NSInteger, MPMovieScalingMode) {
-MPMovieScalingModeNone,       // 无缩放
-MPMovieScalingModeAspectFit,  // 同比适配，某个方向会有黑边
-MPMovieScalingModeAspectFill, // 同比填充，某个方向的显示内容可能被裁剪
-MPMovieScalingModeFill        // 满屏填充，与原始视频比例不一致
-} NS_DEPRECATED_IOS(2_0, 9_0);
-
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      duration -

    - -
    -
    - -
    - - -
    -

    当前视频总时长

    -
    - - - -
    @property (nonatomic, readonly) NSTimeInterval duration
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    视频总时长，单位是秒。

    - -
      -
    • 如果是直播视频源，总时长为0.
      • -
    • 如果该信息未知，总时长默认为0.
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      playableDuration -

    - -
    -
    - -
    - - -
    -

    当前视频可播放长度

    -
    - - - -
    @property (nonatomic, readonly) NSTimeInterval playableDuration
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    视频可播放时长，单位是秒。

    - -
      -
    • currentPlaybackTime 标记的是播放器当前已播放的时长。
      • -
    • playableDuration 标记的是播放器缓冲的时间，会稍大于currentPlaybackTime，与currentPlaybackTime的差值则是缓冲长度。
      • -
    • duration 是视频总时长。
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldEnableKSYStatModule -

    - -
    -
    - -
    - - -
    -

    数据统计，默认开启

    -
    - - - -
    @property (nonatomic, assign) BOOL shouldEnableKSYStatModule
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    可开关

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      naturalSize -

    - -
    -
    - -
    - - -
    -

    当前视频宽高

    -
    - - - -
    @property (nonatomic, readonly) CGSize naturalSize
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    获取信息

    - -
      -
    • 监听MPMovieNaturalSizeAvailableNotification
      • -
    • 播放过程中，宽高信息可能会产生更改
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      naturalRotate -

    - -
    -
    - -
    - - -
    -

    当前视频自带旋转（逆时针）角度

    -
    - - - -
    @property (nonatomic, readonly) NSInteger naturalRotate
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.2.0 and later.

    -
    - - - -
    -

    Discussion

    -

    rotateDegress 是人为旋转角度，naturalRotate是文件meta信息中自带的旋转角度

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      logBlock -

    - -
    -
    - -
    - - -
    -

    获取播放器日志

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    相关字段说明请联系金山云技术支持

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      bufferTimeMax -

    - -
    -
    - -
    - - -
    -

    bufferTimeMax指定播放时的缓冲时长，单位秒

    -
    - - - -
    @property NSTimeInterval bufferTimeMax
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    对于直播流，该属性用于直播延时控制；对于点播流，该属性用于缓冲时长控制

    - -
      -
    • 直播流该属性默认为2秒，设置为0或负值时为关闭直播追赶
      • -
    • 点播流该属性默认为3600秒，且与bufferSizeMax同时生效，两者取小值
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      bufferSizeMax -

    - -
    -
    - -
    - - -
    -

    bufferSizeMax指定点播播放时的最大缓冲，单位MB

    -
    - - - -
    @property NSUInteger bufferSizeMax
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.0 and later.

    -
    - - - -
    -

    Discussion

    -

    取值大小为0-100，超过此区间时将使用默认值15。

    - -
      -
    • 该属性仅对点播视频有效；
      • -
    • 默认值为15。
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      readSize -

    - -
    -
    - -
    - - -
    -

    已经加载的数据大小

    -
    - - - -
    @property (nonatomic, readonly) double readSize
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    已经加载的数据大小，单位是兆。

    - -
      -
    • 已经加载的全部数据大小，包括音频和视频。
      • -
    • 数据包括已经播放的，和当前的cache数据。
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      bufferEmptyDuration -

    - -
    -
    - -
    - - -
    -

    buffer为空时，拉取数据所耗的时长

    -
    - - - -
    @property (nonatomic, readonly) NSTimeInterval bufferEmptyDuration
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    当buffer为空时，开始统计。单位为秒。

    - -
      -
    • 当MPMoviePlayerLoadStateDidChangeNotification 通知发起；
      • -
    • MPMovieLoadState状态为MPMovieLoadStateStalled 开始计时；
      • -
    • MPMovieLoadState状态为MPMovieLoadStatePlayable 或者 MPMovieLoadStatePlaythroughOK时，结束计时；
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      bufferEmptyCount -

    - -
    -
    - -
    - - -
    -

    发起cache的次数

    -
    - - - -
    @property (nonatomic, readonly) NSInteger bufferEmptyCount
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    当buffer为空时，统计一次，统计的条件为

    - -
      -
    • 当MPMoviePlayerLoadStateDidChangeNotification 通知发起
      • -
    • MPMovieLoadState 状态为MPMovieLoadStateStalled
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      serverAddress -

    - -
    -
    - -
    - - -
    -

    视频流server ip

    -
    - - - -
    @property (nonatomic, readonly) NSString *serverAddress
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    当收到prepared后，即可以查询当前连接的视频流server ip

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      clientIP -

    - -
    -
    - -
    - - -
    -

    客户端出口IP

    -
    - - - -
    @property (nonatomic, readonly) NSString *clientIP
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.0.1 and later.

    -
    - - - -
    -

    Discussion

    -

    当收到prepared后，即可以查询客户端的出口IP

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      localDNSIP -

    - -
    -
    - -
    - - -
    -

    客户端LocalDNSIP

    -
    - - - -
    @property (nonatomic, readonly) NSString *localDNSIP
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.0.1 and later.

    -
    - - - -
    -

    Discussion

    -

    当收到prepared后，即可以查询客户端的LocalDNSIP

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      qosInfo -

    - -
    -
    - -
    - - -
    -

    视频流qos信息

    -
    - - - -
    @property (nonatomic, strong) KSYQosInfo *qosInfo
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    在播放过程中，即可以查询当前连接的视频流qos信息

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – thumbnailImageAtCurrentTime -

    - -
    -
    - -
    - - -
    -

    截图

    -
    - - - -
    - (UIImage *)thumbnailImageAtCurrentTime
    - - - - - -
    -

    Return Value

    -

    当前时刻的视频UIImage 图像

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldEnableVideoPostProcessing -

    - -
    -
    - -
    - - -
    -

    是否开启视频后处理

    -
    - - - -
    @property (nonatomic) BOOL shouldEnableVideoPostProcessing
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    默认是关闭

    - - -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      videoDecoderMode -

    - -
    -
    - -
    - - -
    -

    是否开启硬件解码

    -
    - - - -
    @property (nonatomic, assign) MPMovieVideoDecoderMode videoDecoderMode
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    如果系统版本高于8.0，默认开启硬件解码；否则，默认使用软件解码

    - - -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldMute -

    - -
    -
    - -
    - - -
    -

    是否静音

    -
    - - - -
    @property (nonatomic) BOOL shouldMute
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldHideVideo -

    - -
    -
    - -
    - - -
    -

    是否隐藏视频

    -
    - - - -
    @property (nonatomic) BOOL shouldHideVideo
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.6.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      shouldLoop -

    - -
    -
    - -
    - - -
    -

    是否循环播放

    -
    - - - -
    @property (nonatomic) BOOL shouldLoop
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    默认不循环

    - -
      -
    • 只在prepareToPlay 调用前设置生效；
      • -
    • 只有点播生效,直播场景请勿设置
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      videoDataBlock -

    - -
    -
    - -
    - - -
    -

    视频数据回调

    -
    - - - -
    @property (nonatomic, copy) KSYPlyVideoDataBlock videoDataBlock
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.3 and later.

    -
    - - - -
    -

    Discussion

    -

    调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      audioDataBlock -

    - -
    -
    - -
    - - -
    -

    音频数据回调

    -
    - - - -
    @property (nonatomic, copy) KSYPlyAudioDataBlock audioDataBlock
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.3 and later.

    -
    - - - -
    -

    Discussion

    -

    调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      messageDataBlock -

    - -
    -
    - -
    - - -
    -

    消息数据回调

    -
    - - - -
    @property (nonatomic, copy) KSYPlyMessageDataBlock messageDataBlock
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.3 and later.

    -
    - - - -
    -

    Discussion

    -

    调用prepareToPlay方法之前设置生效，回调数据为同步完成后的数据

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      textureBlock -

    - -
    -
    - -
    - - -
    -

    视频图像texture回调

    -
    - - - -
    @property (nonatomic, copy) KSYPlyTextureBlock textureBlock
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.8.7 and later.

    -
    - - - -
    -

    Discussion

    -

    调用prepareToPlay方法之前设置生效

    Warning: 该方法由金山云引入，不是原生系统接口。使用该属性时需要在初始化时使用initWithContentURL:sharegroup:函数初始化播放器，否则该属性无效

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      rotateDegress -

    - -
    -
    - -
    - - -
    -

    指定逆时针旋转角度，只能是0/90/180/270, 不符合上述值不进行旋转

    -
    - - - -
    @property (nonatomic) int rotateDegress
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.4.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      mirror -

    - -
    -
    - -
    - - -
    -

    指定视频是否镜像显示

    -
    - - - -
    @property (nonatomic) BOOL mirror
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.8.4 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      superFastPlay -

    - -
    -
    - -
    - - -
    -

    快速播放

    -
    - - - -
    @property (nonatomic) BOOL superFastPlay
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.2 and later.

    -
    - - - -
    -

    Discussion

    -

    默认不快速播放

    - -
      -
    • 非固定倍速下的快速播放，而是全速将解码器中的数据显示出来
      • -
    • 当播放文件存在音频时该功能生效；
      • -
    • 播放前或者播放过程中均可配置；
      • -
    • 开启快速播放后，不在输出声音，但是audioDataBlock中依然会上抛pcm数据
      • -
    • 开启快速播放后，可能会导致播放器不停的进入/结束缓冲状态；
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      deinterlaceMode -

    - -
    -
    - -
    - - -
    -

    是否进行视频反交错处理

    -
    - - - -
    @property (nonatomic) MPMovieVideoDeinterlaceMode deinterlaceMode
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.7.2 and later.

    -
    - - - -
    -

    Discussion

    -

    默认不进行反交错处理

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      bInterruptOtherAudio -

    - -
    -
    - -
    - - -
    -

    是否打断其他后台的音乐播放

    -
    - - - -
    @property (nonatomic) BOOL bInterruptOtherAudio
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.3 and later.

    -
    - - - -
    -

    Discussion

    -

    也可以理解为是否允许和其他音频同时播放

    YES:开始播放时，会打断其他的后台播放音频，也会被其他音频播放打断

    NO: 可以与其他后台播放共存，相互之间不会被打断

    默认为YES

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      audioPan -

    - -
    -
    - -
    - - -
    -

    立体声平衡模式，默认立体声输出

    -
    - - - -
    @property (nonatomic) MPMovieAudioPan audioPan
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.0.3 and later

    -
    - - - -
    -

    Discussion

    -

    针对单声道或双声道音频播放配置时有效，多声道音频播放配置无效

    需要佩戴耳机以区分左右声道，手机外放无效果

    prepareToPlay前配置无效，应在播放过程中动态配置

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      networkDetectURL -

    - -
    -
    - -
    - - -
    -

    用于检测网络连通性的地址，默认使用地址为“www.baidu.com”

    -
    - - - -
    @property (nonatomic, readwrite) NSString *networkDetectURL
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.1 and later

    -
    - - - -
    -

    Discussion

    -

    用户可自定义地址，但不可设置无效地址，如果不清楚规则，建议使用默认值

    设置为nil时，则关闭网络连通性的检测, networkStatus属性值为-1

    建议在创建对象后设置一次或不设置，不推荐在播放过程中动态配置

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      networkStatus -

    - -
    -
    - -
    - - -
    -

    网络连通状态

    -
    - - - -
    @property (nonatomic, readonly) KSYNetworkStatus networkStatus
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.1 and later

    -
    - - - -
    -

    Discussion

    -

    使用 www.kingsoft.com 作为检测目标

    如果networkStatus不等于KSYNetworkStatus枚举中的任意值，则表明当前尚未监测到网络状态

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

      playbackSpeed -

    - -
    -
    - -
    - - -
    -

    设置播放速度，取值范围(0.5~2.0)，默认1.0

    -
    - - - -
    @property (nonatomic) float playbackSpeed
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.4.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该属性由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setTimeout:readTimeout: -

    - -
    -
    - -
    - - -
    -

    timeout指定拉流超时时间,单位是秒

    -
    - - - -
    - (void)setTimeout:(int)prepareTimeout readTimeout:(int)readTimeout
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    prepareTimeout

    建立链接超时时间，默认值是10秒

    readTimeout

    拉流超时时间，默认值是30秒

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setVolume:rigthVolume: -

    - -
    -
    - -
    - - -
    -

    setVolume指定播放器输出音量

    -
    - - - -
    - (void)setVolume:(float)leftVolume rigthVolume:(float)rightVolume
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    leftVolume

    left volume scalar [0~2.0f]

    rightVolume

    right volume scalar [0~2.0f]

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.3 and later.

    -
    - - - -
    -

    Discussion

    -

    使用说明

    - -
      -
    • 输入参数超出范围将失效
      • -
    • 输出到speaker时需同时设置左右音量为有效值 - 如：leftVolume ＝ rightVolume ＝ 0.5f
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – getVersion -

    - -
    -
    - -
    - - -
    -

    获取sdk版本

    -
    - - - -
    - (NSString *)getVersion
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – getMetadata -

    - -
    -
    - -
    - - -
    -

    获取播放Meta信息

    -
    - - - -
    - (NSDictionary *)getMetadata
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.3.1 and later.

    -
    - - - -
    -

    Discussion

    -

    收到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知后才能获取到数据

    暂时支持的查询包括

    - -
      -
    • kKSYPLYHttpFirstDataTime 建链成功后到收到第一个包所消耗的时间
      • -
    • kKSYPLYHttpConnectTime 链接服务器所消耗的时间
      • -
    • kKSYPLYHttpAnalyzeDns 解析DNS所消耗的时间
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – getMetadata: -

    - -
    -
    - -
    - - -
    -

    获取播放Meta

    -
    - - - -
    - (NSDictionary *)getMetadata:(MPMovieMetaType)metaType
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.5.2 and later.

    -
    - - - -
    -

    Discussion

    -

    收到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知后才能获取到数据

    暂时支持的查询包括

    - -
      -
    • 当metaType为MPMovieMetaType_Media时，所得到的结果与getMetadata方法相同
      • -
    • 当metaType为其他类型时，得到的当前播放的视频/音频/字幕流的meta信息
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – isPlaying -

    - -
    -
    - -
    - - -
    -

    当前播放器是否在播放

    -
    - - - -
    - (BOOL)isPlaying
    - - - - - -
    -

    Return Value

    -

    获取playbackState信息，如果当前状态为MPMoviePlaybackStatePlaying，则返回TRUE。其他情况返回FASLE。

    -
    - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – reload: -

    - -
    -
    - -
    - - -
    -

    重新启动拉流

    -
    - - - -
    - (void)reload:(NSURL *)aUrl
    - - - -
    -

    Parameters

    - - - - - - - -
    aUrl

    视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    调用场景如下：

    - -
      -
    • 当播放器调用方发现卡顿时，可以主动调用
      • -
    • 当估计出更优质的拉流ip时，可以主动调用
      • -
    • 当发生WiFi/3G网络切换时，可以主动调用
      • -
    • 当播放器回调体现播放完成时，可以主动调用
      • -
    • 播放器SDK不会自动调用reload功能
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – reload:flush: -

    - -
    -
    - -
    - - -
    -

    重新启动拉流

    -
    - - - -
    - (void)reload:(NSURL *)aUrl flush:(BOOL)flush
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    aUrl

    视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

    flush

    是否清除上一个url的缓冲区内容，该值为NO不清除，为YES则清除

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • 如果在直播过程中使用reload，希望达到续播的效果，建议flush值设为NO
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – reload:flush:mode: -

    - -
    -
    - -
    - - -
    -

    重新启动拉流

    -
    - - - -
    - (void)reload:(NSURL *)aUrl flush:(bool)flush mode:(MPMovieReloadMode)mode
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    aUrl

    视频播放地址，该地址可以是本地地址或者服务器地址.如果为nil，则使用前一次播放地址

    flush

    是否清除上一个url的缓冲区内容，该值为NO不清除，为YES则清除

    mode

    配置reload后的加载模式，该值为MPMovieReloadModeFast则启用加速播放；若为MPMovieReloadModeAccurate则启用精准查找模式播放

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.6.3 and later.

    -
    - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • 如果在直播过程中使用reload，希望达到续播的效果，建议flush值设为NO
      • -
    • 设置为MPMovieReloadMode_Fast模式可以加快起播速度，但在码流音视频交织较差的情况下，可能无法检测到所有音视频流
      • -
    • 设置为MPMovieReloadMode_Accurate模式起播速度会有所下降，但可以保证检测到所有音视频流
      • -
    • 如果是监听到MPMoviePlayerSuggestReloadNotification消息后调用reload接口，则mode模式一定要设置为MPMovieReloadMode_Accurate，其它情况可根据实际使用场景自行配置
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – getCurrentPts -

    - -
    -
    - -
    - - -
    -

    获取当前播放的pts

    -
    - - - -
    - (NSTimeInterval)getCurrentPts
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.5.0.0 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setUrl: -

    - -
    -
    - -
    - - -
    -

    设置播放url

    -
    - - - -
    - (void)setUrl:(NSURL *)url
    - - - -
    -

    Parameters

    - - - - - - - -
    url

    视频播放地址，该地址可以是本地地址或者服务器地址.

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.6.2 and later.

    -
    - - - -
    -

    Discussion

    -

    使用说明

    - -
      -
    • 通常用于使用一个对象进行多次播放的场景
      • -
    • 调用reset接口停止播放后使用该接口来设置下一次播放地址
      • -
    • 需要在prepareToPlay方法之前设置
      • -
    • v2.1.0及之后的版本，该url不可设置为nil；之前的版本设置为nil，会播放上一次的播放地址
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setUrl:fileList: -

    - -
    -
    - -
    - - -
    -

    设置播放url

    -
    - - - -
    - (void)setUrl:(NSURL *)url fileList:(NSArray *)fileList
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    fileList

    分片列表

    baseURL

    视频播放的绝对地址，该地址可以是本地地址或者服务器地址

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    url和fileList不可同时为nil

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – reset: -

    - -
    -
    - -
    - - -
    -

    重置播放器

    -
    - - - -
    - (void)reset:(BOOL)holdLastPic
    - - - -
    -

    Parameters

    - - - - - - - -
    holdLastPic

    是否保留最后一帧

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.6.2 and later.

    -
    - - - -
    -

    Discussion

    -

    使用说明

    - -
      -
    • 通常用于使用一个对象进行多次播放的场景
      • -
    • 该方法可以停止播放，但是不会销毁播放器
      • -
    • 调用该方法后可以通过调用stop方法来销毁播放器
      • -
    • 如果使用一个对象进行多次播放，需要在reset后使用setUrl方法设置下次播放地址
      • -
    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – seekTo:accurate: -

    - -
    -
    - -
    - - -
    -

    跳转到指定位置播放

    -
    - - - -
    - (void)seekTo:(double)pos accurate:(BOOL)isAccurate
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    pos

    跳转到的位置，单位秒

    isAccurate

    是否精确跳转，NO时等同于currentPlaybackTime, YES时为精确跳转

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 1.9.1 and later.

    -
    - - - -
    -

    Discussion

    -

    媒体文件总时长较小且关键帧间隔较大时，需要使用精确跳转， 总时长较大或者不需要精确定位时可以使用currentPlaybackTime或者将isAccurate设置为NO进行跳转

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setHttpHeaders: -

    - -
    -
    - -
    - - -
    -

    发送http请求时需要header带上的字段

    -
    - - - -
    - (void)setHttpHeaders:(NSDictionary *)headers
    - - - -
    -

    Parameters

    - - - - - - - -
    header

    自定义http header字段

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.0.3 and later.

    -
    - - - -
    -

    Discussion

    -

    在调用prepareToPlay方法前调用生效

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setTrackSelected:selected: -

    - -
    -
    - -
    - - -
    -

    设置开启/关闭指定的媒体轨道

    -
    - - - -
    - (void)setTrackSelected:(NSInteger)trackIndex selected:(BOOL)selected
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    trackIndex
      -
    • 轨道的stream index
      • -
    -
    selected
      -
    • 开启/关闭指定媒体轨道
      • -
    -
    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.5.2 and later.

    -
    - - - -
    -

    Discussion

    -

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    - -

    – setExtSubtitleFilePath: -

    - -
    -
    - -
    - - -
    -

    设置本地字幕文件的地址

    -
    - - - -
    - (void)setExtSubtitleFilePath:(NSString *)subtitleFilePath
    - - - -
    -

    Parameters

    - - - - - - - -
    subtitleFilePath

    本地字幕文件地址

    -
    - - - - - -
    -

    Availability

    -

    Available in KSYMoviePlayerController 2.5.2 and later.

    -
    - - - -
    -

    Discussion

    -

    在播放过程中调用

    Warning: 该方法由金山云引入，不是原生系统接口

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMoviePlayerController.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - -
    + +
    diff --git a/doc/html/Classes/KSYMovieWriter.html b/doc/html/Classes/KSYMovieWriter.html index 6f832f4..4e8eace 100644 --- a/doc/html/Classes/KSYMovieWriter.html +++ b/doc/html/Classes/KSYMovieWriter.html @@ -3,11 +3,11 @@ - KSYMovieWriter Class Reference + - +
    @@ -43,30 +43,10 @@

    @@ -79,149 +59,15 @@

    -

    KSYMovieWriter Class Reference

    +

    -
    - - - - - - - -
    Inherits fromKSYStreamerBase : NSObject
    Declared inKSYMovieWriter.h
    - - -
    - -

    Overview

    -

    视频文件录制类

    -
    - - - -
    - - - - - - -
    -
    - -

    – startWrite: -

    - -
    -
    - -
    - - -
    -

    write video stream to local files

    -
    - - - -
    - (void)startWrite:(NSURL *)filePath
    - - - -
    -

    Parameters

    - - - - - - - -
    filePath

    is local file path

    -
    - - - - - - - -
    -

    Discussion

    -

    开始写文件前需要设定好编码参数

    编码参数主要是视频编码器，音视频码率的设置

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYMovieWriter.h

    -
    - - -
    -
    -
    - -

    – stopWrite -

    - -
    -
    - -
    - - -
    -

    stop wirte file

    -
    - - - -
    - (void)stopWrite
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMovieWriter.h

    -
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYMvEffect.html b/doc/html/Classes/KSYMvEffect.html new file mode 100644 index 0000000..4e8eace --- /dev/null +++ b/doc/html/Classes/KSYMvEffect.html @@ -0,0 +1,87 @@ + + + + + + + + + + + + +
    +
    + +

    + KSYLive_iOS +

    + +

    + Kingsoft +

    + +
    +
    + + + +
    +
    +
    +
    +

    + + + + + + + + +
    + +
    +
    + +

    Copyright © 2017 Kingsoft. All rights reserved.

    + + +
    +
    +
    +
    +
    + + + + diff --git a/doc/html/Classes/KSYMvFilter.html b/doc/html/Classes/KSYMvFilter.html new file mode 100644 index 0000000..4e8eace --- /dev/null +++ b/doc/html/Classes/KSYMvFilter.html @@ -0,0 +1,87 @@ + + + + + + + + + + + + +
    +
    + +

    + KSYLive_iOS +

    + +

    + Kingsoft +

    + +
    +
    + + + +
    +
    +
    +
    +

    + + + + + + + + +
    + +
    +
    + +

    Copyright © 2017 Kingsoft. All rights reserved.

    + + +
    +
    +
    +
    +
    + + + + diff --git a/doc/html/Classes/KSYNetRouterInfo.html b/doc/html/Classes/KSYNetRouterInfo.html index a2f30f3..4e8eace 100644 --- a/doc/html/Classes/KSYNetRouterInfo.html +++ b/doc/html/Classes/KSYNetRouterInfo.html @@ -3,11 +3,11 @@ - KSYNetRouterInfo Class Reference + - +
    @@ -43,40 +43,10 @@

    @@ -89,342 +59,15 @@

    -

    KSYNetRouterInfo Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYNetTracker.h
    - - -
    - -

    Overview

    -

    网络链路上的路由节点信息类

    -
    - - - - - -
    - - - - - - -
    -
    - -

      ips -

    - -
    -
    - -
    - - -
    -

    链路上每个节点的ip地址

    -
    - - - -
    @property (nonatomic, readonly) NSMutableArray *ips
    - - - - - - - - - -
    -

    Discussion

    -

    如果每个探测报文对应的路径不同，则每一跳上会存在多个不同ip

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      tmax -

    - -
    -
    - -
    - - -
    -

    所有探测报文的rtt最大值

    -
    - - - -
    @property (nonatomic, readonly) float tmax
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      tmin -

    - -
    -
    - -
    - - -
    -

    所有探测报文的rtt最小值

    -
    - - - -
    @property (nonatomic, readonly) float tmin
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      tavg -

    - -
    -
    -
    - - -
    -

    所有探测报文的rtt平均值

    -
    - - - -
    @property (nonatomic, readonly) float tavg
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      tdev -

    - -
    -
    - -
    - - -
    -

    所有探测报文的rtt均方差

    -
    - - - -
    @property (nonatomic, readonly) float tdev
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      loss -

    - -
    -
    - -
    - - -
    -

    所有探测报文的丢包率

    -
    - - - -
    @property (nonatomic, readonly) float loss
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      number -

    - -
    -
    - -
    - - -
    -

    统计所使用的探测报文个数

    -
    - - - -
    @property (nonatomic, readonly) int number
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYNetTracker.html b/doc/html/Classes/KSYNetTracker.html index eb8ea85..4e8eace 100644 --- a/doc/html/Classes/KSYNetTracker.html +++ b/doc/html/Classes/KSYNetTracker.html @@ -3,11 +3,11 @@ - KSYNetTracker Class Reference + - +
    @@ -43,44 +43,10 @@

    @@ -93,397 +59,15 @@

    -

    KSYNetTracker Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYNetTracker.h
    - - -
    - -

    Overview

    -

    网络链路探测器类

    -
    - - - -
    - - - - - - -
    -
    - -

    – start: -

    - -
    -
    - -
    - - -
    -

    开始探测

    -
    - - - -
    - (int)start:(NSString *__nonnull)domain
    - - - -
    -

    Parameters

    - - - - - - - -
    domain

    探测地址

    -
    - - - -
    -

    Return Value

    -

    成功开始返回0, 否则返回非0

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

    – stop -

    - -
    -
    - -
    - - -
    -

    停止探测

    -
    - - - -
    - (void)stop
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      action -

    - -
    -
    - -
    - - -
    -

    探测方式

    -
    - - - -
    @property (nonatomic, assign) KSY_NETTRACKER_ACTION action
    - - - - - - - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • start开始前配置有效，探测过程中配置下一次探测生效
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      timeout -

    - -
    -
    - -
    - - -
    -

    探测超时时间，单位是ms，默认值是1000ms

    -
    - - -
    @property (nonatomic, assign) int timeout
    - - - - - - - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • start开始前配置有效，探测过程中配置下一次探测生效
      • -
    • 有效范围是100-2000ms，不在有效范围内的配置不生效
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      maxttl -

    - -
    -
    - -
    - - -
    -

    探测使用的最大ttl值，默认值是64

    -
    - - - -
    @property (nonatomic, assign) int maxttl
    - - - - - - - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • start开始前配置有效，探测过程中配置下一次探测生效
      • -
    • 有效范围是1-int最大值，不在有效范围内的配置不生效
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      number -

    - -
    -
    - -
    - - -
    -

    探测次数，默认值是10

    -
    - - - -
    @property (nonatomic, assign) int number
    - - - - - - - - - -
    -

    Discussion

    -

    说明：

    - -
      -
    • start开始前配置有效，探测过程中配置下一次探测生效
      • -
    • 有效范围是1-20，不在有效范围内的配置不生效
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    - -

      routerInfo -

    - -
    -
    - -
    - - -
    -

    链路状况

    -
    - - - -
    @property (nonatomic, readonly) NSMutableArray *routerInfo
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYNetTracker.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/Classes/KSYQosInfo.html b/doc/html/Classes/KSYQosInfo.html index 4bb1eb0..4e8eace 100644 --- a/doc/html/Classes/KSYQosInfo.html +++ b/doc/html/Classes/KSYQosInfo.html @@ -3,11 +3,11 @@ - KSYQosInfo Class Reference + - +
    @@ -43,44 +43,10 @@

    @@ -93,428 +59,15 @@

    -

    KSYQosInfo Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYQosInfo.h
    - - -
    - -

    Overview

    -

    Qos信息

    -
    - - - - - -
    - - - - - - -
    -
    - -

      audioBufferByteLength -

    - -
    -
    - -
    - - -
    - 
    audio queue size in bytes
-
    -
    - - - -
    @property (nonatomic, assign) int audioBufferByteLength
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      audioBufferTimeLength -

    - -
    -
    - -
    - - -
    - 
    audio queue time length in ms
-
    -
    - - - -
    @property (nonatomic, assign) int audioBufferTimeLength
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      audioTotalDataSize -

    - -
    -
    - -
    - - -
    - 
    size of data have arrived at audio queue since playing. unit:byte
-
    -
    - - - -
    @property (nonatomic, assign) int64_t audioTotalDataSize
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      videoBufferByteLength -

    - -
    -
    - -
    - - -
    - 
    video queue size in bytes
-
    -
    - - - -
    @property (nonatomic, assign) int videoBufferByteLength
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      videoBufferTimeLength -

    - -
    -
    - -
    - - -
    - 
    video queue time length in ms
-
    -
    - - - -
    @property (nonatomic, assign) int videoBufferTimeLength
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      videoTotalDataSize -

    - -
    -
    - -
    - - -
    - 
    size of data have arrived at video queue since playing. unit:byte
-
    -
    - - - -
    @property (nonatomic, assign) int64_t videoTotalDataSize
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      totalDataSize -

    - -
    -
    - -
    - - -
    - 
    size of total audio and video data since playing. unit: byte
-
    -
    - - - -
    @property (nonatomic, assign) int64_t totalDataSize
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      videoDecodeFPS -

    - -
    -
    - -
    - - -
    - 
    video decode frame count per second
-
    -
    - - - -
    @property (nonatomic, assign) float videoDecodeFPS
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    - -

      videoRefreshFPS -

    - -
    -
    - -
    - - -
    - 
    video refresh frame count per second
-
    -
    - - - -
    @property (nonatomic, assign) float videoRefreshFPS
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYQosInfo.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYReachability.html b/doc/html/Classes/KSYReachability.html index 4e9bde0..4e8eace 100644 --- a/doc/html/Classes/KSYReachability.html +++ b/doc/html/Classes/KSYReachability.html @@ -3,11 +3,11 @@ - KSYReachability Class Reference + - +
    @@ -45,76 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -127,410 +59,15 @@

    -

    KSYReachability Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYReachability.h
    - - -
    - - - - - - -
    -
    - -

      reachableBlock -

    - -
    -
    - -
    - - -
    @property (nonatomic, copy) KSYNetworkReachable reachableBlock
    - - -
    -
    -
    - -

      unreachableBlock -

    - -
    -
    - -
    - - -
    @property (nonatomic, copy) KSYNetworkUnreachable unreachableBlock
    - - -
    -
    -
    - -

      reachabilityBlock -

    - -
    -
    - -
    - - -
    @property (nonatomic, copy) KSYNetworkReachability reachabilityBlock
    - - -
    -
    -
    - -

      reachableOnWWAN -

    - -
    -
    - -
    - - -
    @property (nonatomic, assign) BOOL reachableOnWWAN
    - - -
    -
    -
    - -

    + reachabilityWithHostname: -

    - -
    -
    - -
    - - -
    + (instancetype)reachabilityWithHostname:(NSString *)hostname
    - - -
    -
    -
    - -

    + reachabilityWithHostName: -

    - -
    -
    - -
    - - -
    + (instancetype)reachabilityWithHostName:(NSString *)hostname
    - - -
    -
    -
    - -

    + reachabilityForInternetConnection -

    - -
    -
    - -
    - - -
    + (instancetype)reachabilityForInternetConnection
    - - -
    -
    -
    - -

    + reachabilityWithAddress: -

    - -
    -
    - -
    - - -
    + (instancetype)reachabilityWithAddress:(void *)hostAddress
    - - -
    -
    -
    - -

    + reachabilityForLocalWiFi -

    - -
    -
    - -
    - - -
    + (instancetype)reachabilityForLocalWiFi
    - - -
    -
    -
    - -

    – initWithReachabilityRef: -

    - -
    -
    - -
    - - -
    - (instancetype)initWithReachabilityRef:(SCNetworkReachabilityRef)ref
    - - -
    -
    -
    - -

    – startNotifier -

    - -
    -
    - -
    - - -
    - (BOOL)startNotifier
    - - -
    -
    -
    - -

    – stopNotifier -

    - -
    -
    - -
    - - -
    - (void)stopNotifier
    - - -
    -
    -
    - -

    – isReachable -

    - -
    -
    - -
    - - -
    - (BOOL)isReachable
    - - -
    -
    -
    - -

    – isReachableViaWWAN -

    - -
    -
    - -
    - - -
    - (BOOL)isReachableViaWWAN
    - - -
    -
    -
    - -

    – isReachableViaWiFi -

    - -
    -
    - -
    - - -
    - (BOOL)isReachableViaWiFi
    - - -
    -
    -
    - -

    – isConnectionRequired -

    - -
    -
    - -
    - - -
    - (BOOL)isConnectionRequired
    - - -
    -
    -
    - -

    – connectionRequired -

    - -
    -
    - -
    - - -
    - (BOOL)connectionRequired
    - - -
    -
    -
    - -

    – isConnectionOnDemand -

    - -
    -
    - -
    - - -
    - (BOOL)isConnectionOnDemand
    - - -
    -
    -
    - -

    – isInterventionRequired -

    - -
    -
    - -
    - - -
    - (BOOL)isInterventionRequired
    - - -
    -
    -
    - -

    – currentReachabilityStatus -

    - -
    -
    - -
    - - -
    - (KSYNetworkStatus)currentReachabilityStatus
    - - -
    -
    -
    - -

    – reachabilityFlags -

    - -
    -
    - -
    - - -
    - (SCNetworkReachabilityFlags)reachabilityFlags
    - - -
    -
    -
    - -

    – currentReachabilityString -

    - -
    -
    - -
    - - -
    - (NSString *)currentReachabilityString
    - - -
    -
    -
    - -

    – currentReachabilityFlags -

    - -
    -
    - -
    - - -
    - (NSString *)currentReachabilityFlags
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYSpecialEffects.html b/doc/html/Classes/KSYSpecialEffects.html index 5b4618b..4e8eace 100644 --- a/doc/html/Classes/KSYSpecialEffects.html +++ b/doc/html/Classes/KSYSpecialEffects.html @@ -3,11 +3,11 @@ - KSYSpecialEffects Class Reference + - +
    @@ -43,42 +43,10 @@

    @@ -91,245 +59,15 @@

    -

    KSYSpecialEffects Class Reference

    +

    -
    - - - - - - - -
    Inherits fromGPUImageFilterGroup
    Declared inKSYSpecialEffects.h
    - - -
    - -

    Overview

    -

    金山云特效滤镜

    - -

    通过导入查找表资源实现的特效滤镜

    -
    - - - - - -
    - - - - - - -
    -
    - -

    + showVersion -

    - -
    -
    - -
    - - -
    -

    show version of this filter

    -
    - - - -
    + (void)showVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYSpecialEffects.h

    -
    - - -
    -
    -
    - -

    – initWithUIImage: -

    - -
    -
    - -
    - - -
    -

    初始化并指定特效素材

    -
    - - - -
    - (id)initWithUIImage:(UIImage *)image
    - - - -
    -

    Parameters

    - - - - - - - -
    image

    特效素材

    -
    - - - -
    -

    Return Value

    -

    构造的滤镜

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYSpecialEffects.h

    -
    - - -
    -
    -
    - -

    – setSpecialEffectsUIImage: -

    - -
    -
    -
    - - -
    -

    指定特效素材

    -
    - - - -
    - (void)setSpecialEffectsUIImage:(UIImage *)image
    - - - -
    -

    Parameters

    - - - - - - - -
    image

    特效素材

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYSpecialEffects.h

    -
    - - -
    -
    -
    - -

      intensity -

    - -
    -
    - -
    - - -
    -

    特效参数

    -
    - - - -
    @property (readwrite, nonatomic) CGFloat intensity
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYSpecialEffects.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYStreamerBase.html b/doc/html/Classes/KSYStreamerBase.html index 43f6ea1..4e8eace 100644 --- a/doc/html/Classes/KSYStreamerBase.html +++ b/doc/html/Classes/KSYStreamerBase.html @@ -3,11 +3,11 @@ - KSYStreamerBase Class Reference + - +
    @@ -43,174 +43,10 @@

    @@ -223,3641 +59,23 @@

    -

    KSYStreamerBase Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYStreamerBase.h
    - - -
    - -

    Overview

    -

    金山云直播推流SDK iOS版提供了iOS移动设备上的推流功能

    - -
      -
    • 音频编码采用AAC编码，码率可配置;
      • -
    • 视频频编码采用H.264编码，码率可配置;
      • -
    • 支持 RTMP 协议直播推流;
      • -
    • 支持写入本地flv和mp4文件;
      • -
    • 支持推流同时旁路录像功能;
      • -
    - -

    Found: 2015-10-15

    -
    - - - -
    - - + +
    - - - -
    -
    - -

    – getKSYVersion -

    - -
    -
    - -
    - - -
    -

    获取SDK版本号

    -
    - - - -
    - (NSString *)getKSYVersion
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      hostURL -

    - -
    -
    - -
    - - -
    -

    直播推流时为rtmp主机地址; 本地文件录制时,为输出文件路径

    -
    - - - -
    @property (nonatomic, readonly) NSURL *hostURL
    - - - - - - - - - -
    -

    Discussion

    -

    直播时将音视频流推向该主机或写入本地文件

    - -
    eg: rtmp://xxx.xxx.xxx.xxx/appname/streamKey
-eg: /var/xxxxx/xxx.mp4  /var/xxxxx/xxx.flv
-
    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoFPS -

    - -
    -
    - -
    - - -
    -

    视频帧率 默认:15

    -
    - - - -
    @property (nonatomic, assign) int videoFPS
    - - - - - - - - - -
    -

    Discussion

    -

    请保持调用 processVideoSampleBuffer 或 processVideoPixelBuffer 的频率与此设置的帧率一致

    当实际送入的视频帧率过高时会主动丢帧

    video frame per seconds 有效范围[1~30], 超出会提示参数错误

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoMinFPS -

    - -
    -
    - -
    - - -
    -

    视频帧率最小值，默认与videoFPS相同

    -
    - - - -
    @property (nonatomic, assign) int videoMinFPS
    - - - - - - - - - -
    -

    Discussion

    -

    video frame per seconds 有效范围[1~30], 超出会提示参数错误

    不设置该值时表示网络自适应不使用动态帧率

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoMaxFPS -

    - -
    -
    - -
    - - -
    -

    视频帧率最大值，默认与videoFPS相同

    -
    - - - -
    @property (nonatomic, assign) int videoMaxFPS
    - - - - - - - - - -
    -

    Discussion

    -

    video frame per seconds 有效范围[1~30], 超出会提示参数错误

    不设置该值时表示网络自适应不使用动态帧率

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoCodec -

    - -
    -
    - -
    - - -
    -

    视频编码器 默认为 自动选择

    -
    - - - -
    @property (nonatomic, assign) KSYVideoCodec videoCodec
    - - - - - - - - - -
    -

    Discussion

    -

    video codec used for encode

    修改此选项会导致videoEncodePerf值变化

    如果需要定制编码档次, 请在修改videoCodec之后再测设置

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      audioCodec -

    - -
    -
    - -
    - - -
    -

    音频编码器 (默认为AAC-HE)

    -
    - - - -
    @property (nonatomic, assign) KSYAudioCodec audioCodec
    - - - - - - - - - -
    -

    Discussion

    -

    audio codec used for encode

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoInitBitrate -

    - -
    -
    - -
    - - -
    -

    视频编码起始码率（单位:kbps, 默认:500）

    -
    - - - -
    @property (nonatomic, assign) int videoInitBitrate
    - - - - - - - - - -
    -

    Discussion

    -

    开始推流时的视频码率，开始推流后，根据网络情况在Min~Max范围内调节

    视频码率上调则画面更清晰，下调则画面更模糊

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoMaxBitrate -

    - -
    -
    - -
    - - -
    -

    视频编码最高码率（单位:kbps, 默认:800）

    -
    - - - -
    @property (nonatomic, assign) int videoMaxBitrate
    - - - - - - - - - -
    -

    Discussion

    -

    视频码率自适应调整的上限, 为目标码率

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoMinBitrate -

    - -
    -
    - -
    - - -
    -

    视频编码最低码率（单位:kbps, 默认:200）

    -
    - - - -
    @property (nonatomic, assign) int videoMinBitrate
    - - - - - - - - - -
    -

    Discussion

    -

    视频码率自适应调整的下限

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      streamMetaData -

    - -
    -
    - -
    - - -
    -

    推流全局附带的metadata (默认为nil)

    -
    - - - -
    @property (atomic, copy) NSDictionary *streamMetaData
    - - - - - - - - - -
    -

    Discussion

    -

    key 一定要是 NSString* 类型的

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoMetaData -

    - -
    -
    - -
    - - -
    -

    视频流附带的metadata (默认为nil)

    -
    - - - -
    @property (atomic, copy) NSDictionary *videoMetaData
    - - - - - - - - - -
    -

    Discussion

    -

    key 一定要是 NSString* 类型的; 目前有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoCrf -

    - -
    -
    - -
    - - -
    -

    质量等级（默认:20）

    -
    - - - -
    @property (nonatomic, assign) int videoCrf
    - - - - - - - - - -
    -

    Discussion

    -

    视频恒定质量等级，范围0～51，值越小，质量越好

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      maxKeyInterval -

    - -
    -
    - -
    - - -
    -

    最大关键帧间隔（单位:秒, 默认:3）

    -
    - - - -
    @property (nonatomic, assign) float maxKeyInterval
    - - - - - - - - - -
    -

    Discussion

    -

    即GOP长度 画面静止时,隔n秒插入一个关键帧

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      audiokBPS -

    - -
    -
    - -
    - - -
    -

    音频编码码率（单位:kbps）

    -
    - - - -
    @property (nonatomic, assign) int audiokBPS
    - - - - - - - - - -
    -

    Discussion

    -

    音频目标编码码率 (比如48,96,128等)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bwEstimateMode -

    - -
    -
    - -
    - - -
    -

    带宽估计模式

    -
    - - - -
    @property (nonatomic, assign) KSYBWEstimateMode bwEstimateMode
    - - - - - - - - - -
    -

    Discussion

    -

    带宽估计的策略选择 (开始推流前设置有效)

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      liveScene -

    - -
    -
    - -
    - - -
    -

    本次直播的目标场景 (默认为KSYLiveScene_Default)

    -
    - - - -
    @property (nonatomic, assign) KSYLiveScene liveScene
    - - - - - - - - - -
    -

    Discussion

    -

    KSY内部会根据场景的特征进行参数调优,开始推流前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      recScene -

    - -
    -
    - -
    - - -
    -

    本次录制的目标场景 (默认为KSYRecScene_ConstantBitRate)

    -
    - - - -
    @property (nonatomic, assign) KSYRecScene recScene
    - - - - - - - - - -
    -

    Discussion

    -

    开始录制前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoEncodePerf -

    - -
    -
    - -
    - - -
    -

    视频编码性能档次

    -
    - - - -
    @property (nonatomic, assign) KSYVideoEncodePerformance videoEncodePerf
    - - - - - - - - - -
    -

    Discussion

    -

    视频质量和设备资源之间的权衡,开始推流前, videoCodec设置之后,修改有效

    选择软编码的默认为KSYVideoEncodePer_LowPower

    选择Auto或硬编码的默认为KSYVideoEncodePer_HighPerformance

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bWithVideo -

    - -
    -
    - -
    - - -
    -

    是否处理视频的图像数据 (默认YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bWithVideo
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: 如果在推流前设置为NO, 则在推流过程中无法再开启图像

    启动推流前设置为NO, 推流过程中修改本属性无效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bWithAudio -

    - -
    -
    - -
    - - -
    -

    是否处理音频数据 (默认YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bWithAudio
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bWithMessage -

    - -
    -
    - -
    - - -
    -

    是否处理Message (默认YES)

    -
    - - - -
    @property (nonatomic, assign) BOOL bWithMessage
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      scaleRatio -

    - -
    -
    - -
    - - -
    -

    cpu缩放比率,设置>0为按比例缩放，默认为0

    -
    - - - -
    @property (nonatomic, assign) float scaleRatio
    - - - - - - - - - -
    -

    Discussion

    -

    Warning: 请在推流之前进行设置

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      streamState -

    - -
    -
    - -
    - - -
    -

    当前推流状况

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamState streamState
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取推流会话的工作状况

    通知： -* KSYStreamStateDidChangeNotification 当推流工作状态发生变化时提供通知 -* 收到通知后，通过本属性查询新的状态，并作出相应的动作

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – getStreamStateName: -

    - -
    -
    - -
    - - -
    -

    获取推流状态对应的字符串

    -
    - - - -
    - (NSString *)getStreamStateName:(KSYStreamState)stat
    - - - -
    -

    Parameters

    - - - - - - - -
    stat

    状态码

    -
    - - - -
    -

    Return Value

    -

    状态名称

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – getCurStreamStateName -

    - -
    -
    - -
    - - -
    -

    获取当前推流状态对应的字符串

    -
    - - - -
    - (NSString *)getCurStreamStateName
    - - - - - -
    -

    Return Value

    -

    当前状态名称

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      streamErrorCode -

    - -
    -
    - -
    - - -
    -

    当前推流的错误码

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamErrorCode streamErrorCode
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取推流失败的原因

    当streamState 为KSYStreamStateError时可查询

    KSYStreamErrorCode_KSYAUTHFAILED 除外

    在streamState 为KSYStreamStateConnected 时查询到

    状态变化后清0

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      streamStateChange -

    - -
    -
    - -
    - - -
    -

    发生推流状态变化时的回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( KSYStreamState newState ) streamStateChange
    - - - - - - - - - -
    -

    Discussion

    -

    参数为新状态

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – getKSYStreamErrorCodeName: -

    - -
    -
    - -
    - - -
    -

    获取错误码对应的字符串

    -
    - - - -
    - (NSString *)getKSYStreamErrorCodeName:(KSYStreamErrorCode)code
    - - - -
    -

    Parameters

    - - - - - - - -
    code

    错误码

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – getCurKSYStreamErrorCodeName -

    - -
    -
    - -
    - - -
    -

    获取当前错误码对应的字符串

    -
    - - - -
    - (NSString *)getCurKSYStreamErrorCodeName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      netStateCode -

    - -
    -
    - -
    - - -
    -

    当前推流的网络事件

    -
    - - - -
    @property (nonatomic, readonly) KSYNetStateCode netStateCode
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性查询网络状况

    通知： -* KSYNetStateEventNotification 当检测到网络发生特定事件时SDK发出通知 -* 收到通知后，通过本属性查询具体事件类型

    KSYNetStateEventNotification

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      videoFPSChange -

    - -
    -
    - -
    - - -
    -

    帧率应发生变化时的回调函数

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( int32_t newVideoFPS ) videoFPSChange
    - - - - - - - - - -
    -

    Discussion

    -

    参数为建议设定的fps

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – initWithDefaultCfg -

    - -
    -
    - -
    - - -
    -

    初始化方法 （step1）

    -
    - - - -
    - (instancetype)initWithDefaultCfg
    - - - - - - - - - -
    -

    Discussion

    -

    初始化，将下列属性设置为默认值

    - - -

    Warning: KSYStreamerBase只支持单实例推流，构造多个实例会出现异常

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – startStream: -

    - -
    -
    - -
    - - -
    -

    启动推流 （step2）

    -
    - - - -
    - (void)startStream:(NSURL *)url
    - - - -
    -

    Parameters

    - - - - - - - -
    url

    目标地址

    -
    - - - - - - - -
    -

    Discussion

    -

    实现直播功能时, url为 rtmp 服务器地址 “rtmp://xxx.xx/appname/streamKey"

    设置完成推流参数之后，将媒体流推送到 publishURL 对应的地址

    实现本地录制功能时, url为本地文件地址 “/var/xxx/xx.mp4”

    本地录制支持mp4和flv两种输出格式, 通过url的文件后缀指定

    推流参数主要是视频编码器，音视频码率的设置

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – stopStream -

    - -
    -
    - -
    - - -
    -

    停止推流 （step3）

    -
    - - - -
    - (void)stopStream
    - - - - - - - - - -
    -

    Discussion

    -

    断开网络连接 或停止文件写入

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – muteStream: -

    - -
    -
    - -
    - - -
    -

    静音推流 (仍然有音频输出发送, 只是音量为0)

    -
    - - - -
    - (void)muteStream:(BOOL)bMute
    - - - -
    -

    Parameters

    - - - - - - - -
    bMute

    YES / ON

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processVideoSampleBuffer: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    Buffer to process

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始推流前定期调用此接口，比如按照采集帧率调用

    支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processVideoSampleBuffer:onComplete: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoSampleBuffer:(CMSampleBufferRef)sampleBuffer onComplete:(void ( ^ ) ( BOOL ))completion
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    sampleBuffer

    Buffer to process

    completion

    当前视频帧处理完成的回调

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processVideoPixelBuffer:timeInfo: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    pixelBuffer

    待编码的像素数据

    timeStamp

    待编码的时间戳

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始推流前定期调用此接口，比如按照采集帧率调用

    支持的图像格式包括: BGR0,NV12,YUVA444P,YUV420P

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processVideoPixelBuffer:timeInfo:onComplete: -

    - -
    -
    - -
    - - -
    -

    处理一个视频帧(只支持编码前的原始图像数据)

    -
    - - - -
    - (void)processVideoPixelBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp onComplete:(void ( ^ ) ( BOOL ))completion
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - -
    pixelBuffer

    待编码的像素数据

    timeStamp

    待编码的时间戳

    completion

    当前视频帧处理完成的回调

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processAudioSampleBuffer: -

    - -
    -
    - -
    - - -
    -

    处理一段音频数据

    -
    - - - -
    - (void)processAudioSampleBuffer:(CMSampleBufferRef)sampleBuffer
    - - - -
    -

    Parameters

    - - - - - - - -
    sampleBuffer

    Buffer to process

    -
    - - - - - - - -
    -

    Discussion

    -

    应当在开始推流前定期调用此接口，与processVideoSampleBuffer 交错进行

    Warning: 目前只支持 S16 格式的PCM数据

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processAudioData:nbSample:withFormat:timeinfo: -

    - -
    -
    - -
    - - -
    -

    处理一段音频数据

    -
    - - - -
    - (void)processAudioData:(uint8_t **)pData nbSample:(int)len withFormat:(const AudioStreamBasicDescription *)fmt timeinfo:(CMTime *)pts
    - - - -
    -

    Parameters

    - - - - - - - - - - - - - - - - - - - - - - -
    pData

    原始数据指针数组

    len

    数据的长度，单位为字节

    fmt

    原始数据的格式 (必须保证一次推流过程中数据格式不变)

    pts

    原始数据的时间戳

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – processMessageData: -

    - -
    -
    - -
    - - -
    -

    处理一个消息

    -
    - - - -
    - (void)processMessageData:(NSDictionary *)messageData
    - - - -
    -

    Parameters

    - - - - - - - -
    message

    message to process

    -
    - - - - - - - -
    -

    Discussion

    -

    开始推流后发生相应事件时调用此接口 -@warning

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      clientAk -

    - -
    -
    - -
    - - -
    -

    获取当前用户的ak -@warnning 默认是空的，只有在需要鉴权时，才能获取到

    -
    - - - -
    @property (nonatomic, assign) NSString *clientAk
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      expireDate -

    - -
    -
    - -
    - - -
    -

    获取当前SDK过期时间

    -
    - - - -
    @property (nonatomic, assign) NSDate *expireDate
    - - - - - - - - - -
    -

    Discussion

    -

    为nil时,可以永久使用不会过期 -@warnning sdk自行解析得到, 外部赋值无效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      streamID -

    - -
    -
    - -
    - - -
    -

    查询当前推流的事件ID

    -
    - - - -
    @property (nonatomic, readonly) NSString *streamID
    - - - - - - - - - -
    -

    Discussion

    -

    md5(hostURL+timestamp) 对本次推流活动的标识

    timestamp 为建立连接时的事件戳

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – isStreaming -

    - -
    -
    - -
    - - -
    -

    查询当前是否处于推流状态 (建立连接中, 或连接中)

    -
    - - - -
    - (BOOL)isStreaming
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      encodeVKbps -

    - -
    -
    - -
    - - -
    -

    查询当前编码的视频码率大小（每秒更新）

    -
    - - - -
    @property (nonatomic, readonly) double encodeVKbps
    - - - - - - - - - -
    -

    Discussion

    -

    该码率为编码器产生的视频码率大小，单位为kbps

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      encodeAKbps -

    - -
    -
    - -
    - - -
    -

    查询当前编码的音频码率大小（每秒更新）

    -
    - - - -
    @property (nonatomic, readonly) double encodeAKbps
    - - - - - - - - - -
    -

    Discussion

    -

    该码率为编码器产生的音频码率大小，单位为kbps

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      uploadedKByte -

    - -
    -
    - -
    - - -
    -

    查询本次推流发送的流量大小 (仅推流时有效)

    -
    - - - -
    @property (nonatomic, readonly) int uploadedKByte
    - - - - - - - - - -
    -

    Discussion

    -

    从开始推流到现在，发送出去的数据字节数，单位为KByte

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      currentUploadingKbps -

    - -
    -
    - -
    - - -
    -

    查询当前上传的码率大小 (每秒更新)

    -
    - - - -
    @property (nonatomic, readonly) double currentUploadingKbps
    - - - - - - - - - -
    -

    Discussion

    -

    该码率为实际上传的速度, 也就是每秒上传的字节数，单位为kbps

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      encodingFPS -

    - -
    -
    - -
    - - -
    -

    查询当前编码的平均视频帧率

    -
    - - - -
    @property (nonatomic, readonly) double encodingFPS
    - - - - - - - - - -
    -

    Discussion

    -

    采集设备的输出帧率为videoFPS，约等于编码的目标帧率

    编码的视频帧率不会高于采集帧率，但是当CPU资源不足时，编码帧率会低于采集帧率

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      encodedFrames -

    - -
    -
    - -
    - - -
    -

    查询本次推流编码的视频总帧数

    -
    - - - -
    @property (nonatomic, readonly) int encodedFrames
    - - - - - - - - - -
    -

    Discussion

    -

    从开始推流到现在，编码过的视频总帧数

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      droppedVideoFrames -

    - -
    -
    - -
    - - -
    -

    查询本次推流发送的丢帧数量

    -
    - - - -
    @property (nonatomic, readonly) int droppedVideoFrames
    - - - - - - - - - -
    -

    Discussion

    -

    这里是指编码后，由于网络发送阻塞导致丢弃的帧数

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      qosInfo -

    - -
    -
    - -
    - - -
    -

    推流的qos信息

    -
    - - - -
    @property (nonatomic, readonly) KSYStreamerQosInfo *qosInfo
    - - - - - - - - - -
    -

    Discussion

    -

    在推流过程中，查询当前推流qos信息

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      rtmpHostIP -

    - -
    -
    - -
    - - -
    -

    查询当前推流的rtmp服务器的主机IP

    -
    - - - -
    @property (atomic, readonly) NSString *rtmpHostIP
    - - - - - - - - - -
    -

    Discussion

    -

    开始推流之后获取才为有效IP, 之前为空字符串

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      shouldEnableKSYStatModule -

    - -
    -
    - -
    - - -
    -

    收集网络相关状态的日志，默认开启

    -
    - - - -
    @property (nonatomic, assign) BOOL shouldEnableKSYStatModule
    - - - - - - - - - -
    -

    Discussion

    -

    可开关

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      logBlock -

    - -
    -
    - -
    - - -
    -

    获取Streamer中与网络相关的日志

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( NSString *logJson ) logBlock
    - - - - - - - - - -
    -

    Discussion

    -

    相关字段说明请联系金山云技术支持

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – takePhotoWithQuality:fileName: -

    - -
    -
    - -
    - - -
    -

    截图功能，目前只支持jpg格式

    -
    - - - -
    - (void)takePhotoWithQuality:(CGFloat)jpegCompressionQuality fileName:(NSString *)filename
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    jpegCompressionQuality

    设置图像的压缩比例

    filename

    图片的文件名

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – getSnapshotWithCompletion: -

    - -
    -
    - -
    - - -
    -

    获取当前编码的截图

    -
    - - - -
    - (void)getSnapshotWithCompletion:(void ( ^ ) ( UIImage *))completion
    - - - -
    -

    Parameters

    - - - - - - - -
    completion

    通过完成代码块获取到截图完成的图像

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordURL -

    - -
    -
    - -
    - - -
    -

    旁路录像地址

    -
    - - - -
    @property (nonatomic, readonly) NSURL *bypassRecordURL
    - - - - - - - - - -
    -

    Discussion

    -

    开始录像后, 将直播的内容同步存储一份到本地文件 -eg: /private/var/mobile/Containers/Data/Application/APPID/tmp/test.mp4

    如果只要存储本地文件,请继续使用原来的startStream接口

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – startBypassRecord: -

    - -
    -
    - -
    - - -
    -

    启动旁路录像

    -
    - - - -
    - (BOOL)startBypassRecord:(NSURL *)url
    - - - -
    -

    Parameters

    - - - - - - - -
    url

    本地录像文件地址:/private/var/…./test.mp4

    -
    - - - -
    -

    Return Value

    -

    是否能尝试启动写入, 不能表明真正开始录像了,真正开始请确认bypassRecordState的值

    -
    - - - - - -
    -

    Discussion

    -

    启动推流后才能开始写入文件

    文件中的内容和直播内容完全一致

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

    – stopBypassRecord -

    - -
    -
    - -
    - - -
    -

    停止旁路录像

    -
    - - - -
    - (void)stopBypassRecord
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordDuration -

    - -
    -
    - -
    - - -
    -

    旁路录像的文件时长

    -
    - - - -
    @property (nonatomic, readonly) double bypassRecordDuration
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordState -

    - -
    -
    - -
    - - -
    -

    旁路录像的状态

    -
    - - - -
    @property (nonatomic, readonly) KSYRecordState bypassRecordState
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordErrorCode -

    - -
    -
    - -
    - - -
    -

    旁路录像的错误码

    -
    - - - -
    @property (nonatomic, readonly) KSYRecordError bypassRecordErrorCode
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordErrorName -

    - -
    -
    - -
    - - -
    -

    旁路录像的错误名称

    -
    - - - -
    @property (nonatomic, readonly) NSString *bypassRecordErrorName
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      bypassRecordStateChange -

    - -
    -
    - -
    - - -
    -

    当旁路录制的状态变化时

    -
    - - - -
    @property (nonatomic, copy) void ( ^ ) ( KSYRecordState recordState ) bypassRecordStateChange
    - - - - - - - - - -
    -

    Discussion

    -

    只有设置 loop为NO时才有效, 在开始播放前设置有效

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      shouldEnableKSYDropModule -

    - -
    -
    - -
    - - -
    -

    是否允许编码前丢帧，默认开启 -@warnning 请勿在直播时使用，否则可能出现音视频不同步，仅在离线转码需要输出所有帧的情况下开启

    -
    - - - -
    @property (nonatomic, assign) BOOL shouldEnableKSYDropModule
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      netReachability -

    - -
    -
    - -
    - - -
    -

    / 网络状态监控 (当SDK内部发现网络不可用时主动发出connet_break的错误码)

    -
    - - - -
    @property (nonatomic, readonly) KSYReachability *netReachability
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      netReachState -

    - -
    -
    - -
    - - -
    -

    是否能连通外网

    -
    - - - -
    @property (nonatomic, readonly) KSYNetReachState netReachState
    - - - - - - - - - -
    -

    Discussion

    -

    networkDetectURL为nil或未探测到结果前，该值为KSYNetReachState_Unknown

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    - -

      reachabilityDetectURL -

    - -
    -
    - -
    - - -
    -

    用于检测网络连通性的地址，默认使用地址为“www.baidu.com”

    -
    - - - -
    @property (nonatomic, readwrite) NSString *reachabilityDetectURL
    - - - - - - - -
    -

    Availability

    -

    Available in KSYLive_iOS 2.1.1 and later

    -
    - - - -
    -

    Discussion

    -

    用户可自定义地址，但不可设置无效地址，如果不清楚规则，建议使用默认值

    设置为nil时，则关闭网络连通性的检测, netReachability为nil，netReachState为KSYNetReachState_Unknown

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYStreamerBase.h

    -
    - - -
    -
    -
    -
    - -
    - - - - - - - - -
    -
    +
    diff --git a/doc/html/Classes/KSYTranscoder.html b/doc/html/Classes/KSYTranscoder.html index a1c2625..4e8eace 100644 --- a/doc/html/Classes/KSYTranscoder.html +++ b/doc/html/Classes/KSYTranscoder.html @@ -3,11 +3,11 @@ - KSYTranscoder Class Reference + - +
    @@ -43,44 +43,10 @@

    @@ -93,406 +59,15 @@

    -

    KSYTranscoder Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYTranscoder.h
    - - -
    - -

    Overview

    -

    不同音视频文件格式间的转码

    -
     1. 输入可以是本地文件/HTTP/RTMP/HLS
- 2. 输出只能是本地文件
- 3. 只提供不同封装格式间转换的功能，不涉及音视频编码格式的转换
- 4. 目前只支持单路音视频流的转换
- 5. 输出格式目前只支持FLV和MOV
-
    -
    - - - - -
    - - - - - - -
    -
    - -

    – startTranscode:outputFilePath: -

    - -
    -
    - -
    - - -
    -

    开始转换

    -
    - - - -
    - (void)startTranscode:(NSURL *)inputFilePath outputFilePath:(NSURL *)outputFilePath
    - - - -
    -

    Parameters

    - - - - - - - - - - - - -
    inputFilePath

    输入文件路径

    outputFilePath

    输出文件路径

    -
    - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

    – stopTranscode -

    - -
    -
    - -
    - - -
    -

    停止转换

    -
    - - - -
    - (void)stopTranscode
    - - - - - - - - - -
    -

    Discussion

    -

    与startTransform配对调用，除Idle状态外，其他状态下结束转码时都需要调用，否则可能会造成内存泄露

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

      duration -

    - -
    -
    - -
    - - -
    -

    转换文件的总时长，单位是秒

    -
    - - - -
    @property (nonatomic, readonly) float duration
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

      position -

    - -
    -
    - -
    - - -
    -

    当前转换位置，单位是秒

    -
    - - - -
    @property (nonatomic, readonly) float position
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

      progress -

    - -
    -
    - -
    - - -
    -

    转换进度

    -
    - - - -
    @property (nonatomic, readonly) float progress
    - - - - - - - - - -
    -

    Discussion

    -

    取值从0.0~1.0，大小为position/duration;

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

      transcodeState -

    - -
    -
    - -
    - - -
    -

    当前转码状况

    -
    - - - -
    @property (nonatomic, readonly) KSYTranscodeState transcodeState
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取转码器的工作状况

    通知： -* KSYTranscodeStateDidChangeNotification 当转码器状态发生变化时提供通知 -* 可通过userInfo获取转换后的状态，关键字为KSYTranscodeStateUserInfoKey -* 也可以收到通知后，通过本属性查询新的状态，并作出相应的动作

    状态机转换： -* 创建转码对象后状态为KSYTranscodeState_Idle -* 只能在KSYTranscodeStateIdle状态下调用 startTranscode 方法, - - 成功状态转为KSYTranscodeStateTranscoding - - 失败则转为KSYTranscodeStateError -* 开始转码后 - - 转码完成状态转为KSYTranscodeStateCompleted - - 转码过程中出现问题状态转为KSYTranscodeStateError -* 调用 stopTranscode 可将状态转为KSYTranscodeStateIdle

    -
    - - - - - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    - -

      transcodeErrorCode -

    - -
    -
    - -
    - - -
    -

    转码器的错误码

    -
    - - - -
    @property (nonatomic, readonly) KSYTranscodeErrorCode transcodeErrorCode
    - - - - - - - - - -
    -

    Discussion

    -

    可以通过该属性获取转码失败的原因 -@discussion -* 当transcoderStatus为KSYTranscodeState_Error时可查询 -* 当transcoderStatus为其他值时，错误码为KSYTranscodingErrorCode_NONE

    通知： - * KSYTranscodeStateDidChangeNotification 当转码器状态发生变化时提供通知 - * 可通过userInfo获取当前错误码，关键字为KSYTranscodeErrorCodeInfoKey

    -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYTranscoder.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -

    diff --git a/doc/html/Classes/KSYUIRecorderKit.html b/doc/html/Classes/KSYUIRecorderKit.html index f16070d..4e8eace 100644 --- a/doc/html/Classes/KSYUIRecorderKit.html +++ b/doc/html/Classes/KSYUIRecorderKit.html @@ -3,11 +3,11 @@ - KSYUIRecorderKit Class Reference + - +
    @@ -45,44 +45,8 @@

    - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @@ -95,186 +59,15 @@

    -

    KSYUIRecorderKit Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYUIRecorderKit.h
    - - -
    - - - - - - -
    -
    - -

    – initWithScheme: -

    - -
    -
    - -
    - - -
    - (instancetype)initWithScheme:(KSYPlayRecordScheme)scheme
    - - -
    -
    -
    - -

      contentView -

    - -
    -
    - -
    - - -
    @property (nonatomic, readwrite) UIView *contentView
    - - -
    -
    -
    - -

    – processWithTextureId:TextureSize:Time: -

    - -
    -
    - -
    - - -
    - (void)processWithTextureId:(GLuint)InputTexture TextureSize:(CGSize)TextureSize Time:(CMTime)time
    - - -
    -
    -
    - -

    – processAudioSampleBuffer: -

    - -
    -
    - -
    - - -
    - (void)processAudioSampleBuffer:(CMSampleBufferRef)buf
    - - -
    -
    -
    - -

    – processVideoSampleBuffer:timeInfo: -

    - -
    -
    - -
    - - -
    - (void)processVideoSampleBuffer:(CVPixelBufferRef)pixelBuffer timeInfo:(CMTime)timeStamp
    - - -
    -
    -
    - -

    – startRecord: -

    - -
    -
    - -
    - - -
    - (void)startRecord:(NSURL *)path
    - - -
    -
    -
    - -

    – stopRecord -

    - -
    -
    - -
    - - -
    - (void)stopRecord
    - - -
    -
    -
    - -

      bPlayRecord -

    - -
    -
    - -
    - - -
    @property BOOL bPlayRecord
    - - -
    -
    -
    - -

      writer -

    - -
    -
    - -
    - - -
    @property (nonatomic, readwrite) KSYMovieWriter *writer
    - - -
    -
    -
    -
    - -
    - - - -
    diff --git a/doc/html/Classes/KSYVideoInfo.html b/doc/html/Classes/KSYVideoInfo.html index 2a6bee2..4e8eace 100644 --- a/doc/html/Classes/KSYVideoInfo.html +++ b/doc/html/Classes/KSYVideoInfo.html @@ -3,11 +3,11 @@ - KSYVideoInfo Class Reference + - +
    @@ -43,32 +43,10 @@

    @@ -81,173 +59,15 @@

    -

    KSYVideoInfo Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSObject
    Declared inKSYMediaInfo.h
    - - -
    - -

    Overview

    -

    视频信息

    -
    - - - - - -
    - - - - - - -
    -
    - -

      vcodec -

    - -
    -
    - -
    - - -
    -

    视频编码格式, 具体类型为MEDIAINFO_CODEC_ID

    -
    - - - -
    @property (nonatomic) MEDIAINFO_CODEC_ID vcodec
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      frame_width -

    - -
    -
    - -
    - - -
    -

    视频帧宽度

    -
    - - - -
    @property (nonatomic, assign) int32_t frame_width
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    - -

      frame_height -

    - -
    -
    - -
    - - -
    -

    视频帧高度

    -
    - - - -
    @property (nonatomic, assign) int32_t frame_height
    - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYMediaInfo.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Classes/KSYWeakProxy.html b/doc/html/Classes/KSYWeakProxy.html index 38de4fb..4e8eace 100644 --- a/doc/html/Classes/KSYWeakProxy.html +++ b/doc/html/Classes/KSYWeakProxy.html @@ -3,11 +3,11 @@ - KSYWeakProxy Class Reference + - +
    @@ -43,40 +43,10 @@

    @@ -89,223 +59,15 @@

    -

    KSYWeakProxy Class Reference

    +

    -
    - - - - - - - -
    Inherits fromNSProxy
    Declared inKSYWeakProxy.h
    - - -
    - -

    Overview

    -

    A proxy used to hold a weak object. -It can be used to avoid retain cycles, such as the target in NSTimer or CADisplayLink.

    - -

    sample code:

    - -
     @implementation ViewController {
-    NSTimer *_timer;
- }
-
- - (void)initTimer {
-    KSYWeakProxy *proxy = [KSYWeakProxy proxyWithTarget:self];
-    _timer = [NSTimer timerWithTimeInterval:0.1 target:proxy selector:@selector(tick:) userInfo:nil repeats:YES];
- }
-
- - (void)tick:(NSTimer *)timer {...}
- @end
-
    -
    - - - - - -
    - - - - - - -
    -
    - -

      target -

    - -
    -
    - -
    - - -
    -

    The proxy target.

    -
    - - - -
    @property (nullable, nonatomic, weak, readonly) id target
    - - - - - - - - - - - - - - - -
    -

    Declared In

    -

    KSYWeakProxy.h

    -
    - - -
    -
    -
    - -

    – initWithTarget: -

    - -
    -
    - -
    - - -
    -

    Creates a new weak proxy for target.

    -
    - - - -
    - (instancetype)initWithTarget:(id)target
    - - - -
    -

    Parameters

    - - - - - - - -
    target

    Target object.

    -
    - - - -
    -

    Return Value

    -

    A new proxy object.

    -
    - - - - - - - - - - -
    -

    Declared In

    -

    KSYWeakProxy.h

    -
    - - -
    -
    -
    - -

    + proxyWithTarget: -

    - -
    -
    - -
    - - -
    -

    Creates a new weak proxy for target.

    -
    - - - -
    + (instancetype)proxyWithTarget:(id)target
    - - - -
    -

    Parameters

    - - - - - - - -
    target

    Target object.

    -
    - - - -
    -

    Return Value

    -

    A new proxy object.

    -
    - - - - - - - - - - - -
    -

    Declared In

    -

    KSYWeakProxy.h

    -
    - - -
    -
    -
    -
    - -
    - - -
    diff --git a/doc/html/Constants/KSYAVMuxerStatus.html b/doc/html/Constants/KSYAVMuxerStatus.html index 4b2e018..42c33b5 100644 --- a/doc/html/Constants/KSYAVMuxerStatus.html +++ b/doc/html/Constants/KSYAVMuxerStatus.html @@ -3,11 +3,11 @@ - KSYAVMuxerStatus Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYAVMuxerStatus Constants Reference

    +

    -
    - - - - -
    Declared inKSYAVMuxer.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

    @@ -166,7 +159,7 @@

    Constants

    - Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

    @@ -183,7 +176,7 @@

    Constants

    - Declared In KSYAVMuxer.h. + KSYAVMuxer.h.

    @@ -199,14 +192,12 @@

    Constants

    -

    Declared In

    +

    KSYAVMuxer.h

    - -
    diff --git a/doc/html/Constants/KSYAudioCodec.html b/doc/html/Constants/KSYAudioCodec.html index ab382c7..ca6e1e9 100644 --- a/doc/html/Constants/KSYAudioCodec.html +++ b/doc/html/Constants/KSYAudioCodec.html @@ -3,11 +3,11 @@ - KSYAudioCodec Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYAudioCodec Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -147,7 +140,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -164,7 +157,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -180,14 +173,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYAudioEffectType.html b/doc/html/Constants/KSYAudioEffectType.html index 05f90c0..e4c2b7f 100644 --- a/doc/html/Constants/KSYAudioEffectType.html +++ b/doc/html/Constants/KSYAudioEffectType.html @@ -3,11 +3,11 @@ - KSYAudioEffectType Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYAudioEffectType Constants Reference

    +

    -
    - - - - -
    Declared inKSYAUAudioCapture.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -166,7 +159,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -183,7 +176,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -199,14 +192,12 @@

    Constants

    -

    Declared In

    +

    KSYAUAudioCapture.h

    - -
    diff --git a/doc/html/Constants/KSYAudioNoiseSuppress.html b/doc/html/Constants/KSYAudioNoiseSuppress.html index acba38f..b50e1f4 100644 --- a/doc/html/Constants/KSYAudioNoiseSuppress.html +++ b/doc/html/Constants/KSYAudioNoiseSuppress.html @@ -3,11 +3,11 @@ - KSYAudioNoiseSuppress Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYAudioNoiseSuppress Constants Reference

    +

    -
    - - - - -
    Declared inKSYAUAudioCapture.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -166,7 +159,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -183,7 +176,7 @@

    Constants

    - Declared In KSYAUAudioCapture.h. + KSYAUAudioCapture.h.

    @@ -199,14 +192,12 @@

    Constants

    -

    Declared In

    +

    KSYAUAudioCapture.h

    - -
    diff --git a/doc/html/Constants/KSYBWEstimateMode.html b/doc/html/Constants/KSYBWEstimateMode.html index 2532f5f..464bd04 100644 --- a/doc/html/Constants/KSYBWEstimateMode.html +++ b/doc/html/Constants/KSYBWEstimateMode.html @@ -3,11 +3,11 @@ - KSYBWEstimateMode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYBWEstimateMode Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -111,7 +104,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -128,7 +121,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -145,7 +138,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -161,14 +154,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYBgmPlayerState.html b/doc/html/Constants/KSYBgmPlayerState.html index b379964..e091618 100644 --- a/doc/html/Constants/KSYBgmPlayerState.html +++ b/doc/html/Constants/KSYBgmPlayerState.html @@ -3,11 +3,11 @@ - KSYBgmPlayerState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYBgmPlayerState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -119,7 +112,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -136,7 +129,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -153,7 +146,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -170,7 +163,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -187,7 +180,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -204,7 +197,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -221,7 +214,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -237,14 +230,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYCaptureState.html b/doc/html/Constants/KSYCaptureState.html index 5f1b20c..37ddf40 100644 --- a/doc/html/Constants/KSYCaptureState.html +++ b/doc/html/Constants/KSYCaptureState.html @@ -3,11 +3,11 @@ - KSYCaptureState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYCaptureState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -117,7 +110,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -134,7 +127,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -185,7 +178,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -202,7 +195,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -218,14 +211,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYDevAuthStatus.html b/doc/html/Constants/KSYDevAuthStatus.html index 64f20cd..4524aa4 100644 --- a/doc/html/Constants/KSYDevAuthStatus.html +++ b/doc/html/Constants/KSYDevAuthStatus.html @@ -3,11 +3,11 @@ - KSYDevAuthStatus Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYDevAuthStatus Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -117,7 +110,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -134,7 +127,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -184,14 +177,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYLiveScene.html b/doc/html/Constants/KSYLiveScene.html index 28face6..27cdf64 100644 --- a/doc/html/Constants/KSYLiveScene.html +++ b/doc/html/Constants/KSYLiveScene.html @@ -3,11 +3,11 @@ - KSYLiveScene Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYLiveScene Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -165,14 +158,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYMPErrorCode.html b/doc/html/Constants/KSYMPErrorCode.html index d6497a0..d37a3f1 100644 --- a/doc/html/Constants/KSYMPErrorCode.html +++ b/doc/html/Constants/KSYMPErrorCode.html @@ -3,11 +3,11 @@ - KSYMPErrorCode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYMPErrorCode Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -185,7 +178,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -202,7 +195,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -219,7 +212,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -236,7 +229,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -253,7 +246,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -270,7 +263,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -287,7 +280,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -304,7 +297,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -321,7 +314,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -338,7 +331,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -355,7 +348,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -372,7 +365,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -389,7 +382,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -406,7 +399,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -423,7 +416,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -440,7 +433,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -457,7 +450,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -474,7 +467,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -491,7 +484,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -507,14 +500,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/KSYMicType.html b/doc/html/Constants/KSYMicType.html index aa1e3ed..661e545 100644 --- a/doc/html/Constants/KSYMicType.html +++ b/doc/html/Constants/KSYMicType.html @@ -3,11 +3,11 @@ - KSYMicType Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYMicType Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -117,7 +110,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -134,7 +127,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -184,14 +177,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYNetReachState.html b/doc/html/Constants/KSYNetReachState.html index af202b2..df9c929 100644 --- a/doc/html/Constants/KSYNetReachState.html +++ b/doc/html/Constants/KSYNetReachState.html @@ -3,11 +3,11 @@ - KSYNetReachState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYNetReachState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -111,7 +104,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -128,7 +121,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -145,7 +138,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -161,14 +154,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYNetStateCode.html b/doc/html/Constants/KSYNetStateCode.html index 6ca5057..d1ab0e9 100644 --- a/doc/html/Constants/KSYNetStateCode.html +++ b/doc/html/Constants/KSYNetStateCode.html @@ -3,11 +3,11 @@ - KSYNetStateCode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYNetStateCode Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -125,7 +118,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -142,7 +135,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -159,7 +152,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -176,7 +169,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -193,7 +186,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -210,7 +203,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -227,7 +220,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -244,7 +237,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -261,7 +254,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -278,7 +271,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -294,14 +287,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYNetworkStatus.html b/doc/html/Constants/KSYNetworkStatus.html index f0e5599..bb92163 100644 --- a/doc/html/Constants/KSYNetworkStatus.html +++ b/doc/html/Constants/KSYNetworkStatus.html @@ -3,11 +3,11 @@ - KSYNetworkStatus Constants Reference + - +
    @@ -59,19 +59,9 @@

    -

    KSYNetworkStatus Constants Reference

    +

    -
    - - - - - - - -
    Declared inKSYReachability.h
    Referenceshttp://nshipster.com/ns_enum-ns_options/
    - @@ -118,7 +108,7 @@

    Constants

    - Declared In KSYReachability.h. + KSYReachability.h.

    @@ -135,7 +125,7 @@

    Constants

    - Declared In KSYReachability.h. + KSYReachability.h.

    @@ -152,7 +142,7 @@

    Constants

    - Declared In KSYReachability.h. + KSYReachability.h.

    @@ -166,25 +156,21 @@

    Constants

    -

    See Also

    +

    -

    Declared In

    +

    KSYReachability.h

    - -
    diff --git a/doc/html/Constants/KSYPlayRecordScheme.html b/doc/html/Constants/KSYPlayRecordScheme.html index f7ff606..85f87e0 100644 --- a/doc/html/Constants/KSYPlayRecordScheme.html +++ b/doc/html/Constants/KSYPlayRecordScheme.html @@ -3,11 +3,11 @@ - KSYPlayRecordScheme Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYPlayRecordScheme Constants Reference

    +

    -
    - - - - -
    Declared inKSYUIRecorderKit.h
    - @@ -109,7 +102,7 @@

    Constants

    - Declared In KSYUIRecorderKit.h. + KSYUIRecorderKit.h.

    @@ -126,7 +119,7 @@

    Constants

    - Declared In KSYUIRecorderKit.h. + KSYUIRecorderKit.h.

    @@ -142,14 +135,12 @@

    Constants

    -

    Declared In

    +

    KSYUIRecorderKit.h

    - -
    diff --git a/doc/html/Constants/KSYRecScene.html b/doc/html/Constants/KSYRecScene.html index 806a303..184834c 100644 --- a/doc/html/Constants/KSYRecScene.html +++ b/doc/html/Constants/KSYRecScene.html @@ -3,11 +3,11 @@ - KSYRecScene Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYRecScene Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -146,14 +139,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYRecordError.html b/doc/html/Constants/KSYRecordError.html index badb7bb..55079d1 100644 --- a/doc/html/Constants/KSYRecordError.html +++ b/doc/html/Constants/KSYRecordError.html @@ -3,11 +3,11 @@ - KSYRecordError Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYRecordError Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -147,7 +140,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -164,7 +157,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -180,14 +173,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYRecordState.html b/doc/html/Constants/KSYRecordState.html index 583f1ed..09d9cb4 100644 --- a/doc/html/Constants/KSYRecordState.html +++ b/doc/html/Constants/KSYRecordState.html @@ -3,11 +3,11 @@ - KSYRecordState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYRecordState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -147,7 +140,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -164,7 +157,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -180,14 +173,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYStreamErrorCode.html b/doc/html/Constants/KSYStreamErrorCode.html index 2924aa3..8a71796 100644 --- a/doc/html/Constants/KSYStreamErrorCode.html +++ b/doc/html/Constants/KSYStreamErrorCode.html @@ -3,11 +3,11 @@ - KSYStreamErrorCode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYStreamErrorCode Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -177,7 +170,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -194,7 +187,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -211,7 +204,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -228,7 +221,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -245,7 +238,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -262,7 +255,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -279,7 +272,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -296,7 +289,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -313,7 +306,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -330,7 +323,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -347,7 +340,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -364,7 +357,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -381,7 +374,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -398,7 +391,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -415,7 +408,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -432,7 +425,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -449,7 +442,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -466,7 +459,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -483,7 +476,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -500,7 +493,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -517,7 +510,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -534,7 +527,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -551,7 +544,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -568,7 +561,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -585,7 +578,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -602,7 +595,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -619,7 +612,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -636,7 +629,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -653,7 +646,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -670,7 +663,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -687,7 +680,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -704,7 +697,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -721,7 +714,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -738,7 +731,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -755,7 +748,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -772,7 +765,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -788,14 +781,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYStreamState.html b/doc/html/Constants/KSYStreamState.html index 2629cec..95aa7cc 100644 --- a/doc/html/Constants/KSYStreamState.html +++ b/doc/html/Constants/KSYStreamState.html @@ -3,11 +3,11 @@ - KSYStreamState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYStreamState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -166,7 +159,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -183,7 +176,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -199,14 +192,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYTranscodeErrorCode.html b/doc/html/Constants/KSYTranscodeErrorCode.html index 9d37068..a8481bc 100644 --- a/doc/html/Constants/KSYTranscodeErrorCode.html +++ b/doc/html/Constants/KSYTranscodeErrorCode.html @@ -3,11 +3,11 @@ - KSYTranscodeErrorCode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYTranscodeErrorCode Constants Reference

    +

    -
    - - - - -
    Declared inKSYTranscoder.h
    - @@ -123,7 +116,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -140,7 +133,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -157,7 +150,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -174,7 +167,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -191,7 +184,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -208,7 +201,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -225,7 +218,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -242,7 +235,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -259,7 +252,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -275,14 +268,12 @@

    Constants

    -

    Declared In

    +

    KSYTranscoder.h

    - -
    diff --git a/doc/html/Constants/KSYTranscodeState.html b/doc/html/Constants/KSYTranscodeState.html index b446b7f..5bc0140 100644 --- a/doc/html/Constants/KSYTranscodeState.html +++ b/doc/html/Constants/KSYTranscodeState.html @@ -3,11 +3,11 @@ - KSYTranscodeState Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYTranscodeState Constants Reference

    +

    -
    - - - - -
    Declared inKSYTranscoder.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -147,7 +140,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -164,7 +157,7 @@

    Constants

    - Declared In KSYTranscoder.h. + KSYTranscoder.h.

    @@ -180,14 +173,12 @@

    Constants

    -

    Declared In

    +

    KSYTranscoder.h

    - -
    diff --git a/doc/html/Constants/KSYVideoCodec.html b/doc/html/Constants/KSYVideoCodec.html index 4bd78d0..5588ee8 100644 --- a/doc/html/Constants/KSYVideoCodec.html +++ b/doc/html/Constants/KSYVideoCodec.html @@ -3,11 +3,11 @@ - KSYVideoCodec Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYVideoCodec Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -91,6 +84,8 @@

    Definition

       KSYVideoCodec_VT264,
    +    KSYVideoCodec_VT265,
    +    KSYVideoCodec_AUTO = 100,
       KSYVideoCodec_GIF,
    @@ -115,7 +110,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -132,7 +127,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -149,7 +144,24 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h. +

    + + + +
    KSYVideoCodec_VT265
    +
    + + +

    视频编码器 - iOS VT265硬件编码器 (iOS 11.0 以上)

    + + + + + + +

    + KSYTypeDef.h.

    @@ -166,7 +178,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -183,7 +195,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -199,14 +211,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYVideoDimension.html b/doc/html/Constants/KSYVideoDimension.html index 9a05610..efe49c9 100644 --- a/doc/html/Constants/KSYVideoDimension.html +++ b/doc/html/Constants/KSYVideoDimension.html @@ -3,11 +3,11 @@ - KSYVideoDimension Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYVideoDimension Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -125,7 +118,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -142,7 +135,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -159,7 +152,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -176,7 +169,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -193,7 +186,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -210,7 +203,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -227,7 +220,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -244,7 +237,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -260,14 +253,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSYVideoEncodePerformance.html b/doc/html/Constants/KSYVideoEncodePerformance.html index 02670dd..9430a8a 100644 --- a/doc/html/Constants/KSYVideoEncodePerformance.html +++ b/doc/html/Constants/KSYVideoEncodePerformance.html @@ -3,11 +3,11 @@ - KSYVideoEncodePerformance Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSYVideoEncodePerformance Constants Reference

    +

    -
    - - - - -
    Declared inKSYTypeDef.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYTypeDef.h. + KSYTypeDef.h.

    @@ -165,14 +158,12 @@

    Constants

    -

    Declared In

    +

    KSYTypeDef.h

    - -
    diff --git a/doc/html/Constants/KSY_NETTRACKER_ACTION.html b/doc/html/Constants/KSY_NETTRACKER_ACTION.html index e0e126f..fc6f8b4 100644 --- a/doc/html/Constants/KSY_NETTRACKER_ACTION.html +++ b/doc/html/Constants/KSY_NETTRACKER_ACTION.html @@ -3,11 +3,11 @@ - KSY_NETTRACKER_ACTION Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    KSY_NETTRACKER_ACTION Constants Reference

    +

    -
    - - - - -
    Declared inKSYNetTracker.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYNetTracker.h. + KSYNetTracker.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYNetTracker.h. + KSYNetTracker.h.

    @@ -146,14 +139,12 @@

    Constants

    -

    Declared In

    +

    KSYNetTracker.h

    - -
    diff --git a/doc/html/Constants/MEDIAINFO_CODEC_ID.html b/doc/html/Constants/MEDIAINFO_CODEC_ID.html index d8a44de..752ee67 100644 --- a/doc/html/Constants/MEDIAINFO_CODEC_ID.html +++ b/doc/html/Constants/MEDIAINFO_CODEC_ID.html @@ -3,11 +3,11 @@ - MEDIAINFO_CODEC_ID Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MEDIAINFO_CODEC_ID Constants Reference

    +

    -
    - - - - -
    Declared inKSYMediaInfo.h
    - @@ -139,7 +132,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -156,7 +149,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -173,7 +166,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -190,7 +183,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -207,7 +200,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -224,7 +217,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -241,7 +234,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -258,7 +251,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -275,7 +268,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -292,7 +285,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -309,7 +302,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -326,7 +319,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -343,7 +336,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -360,7 +353,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -377,7 +370,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -393,14 +386,12 @@

    Constants

    -

    Declared In

    +

    KSYMediaInfo.h

    - -
    diff --git a/doc/html/Constants/MEDIAINFO_MUX_TYPE.html b/doc/html/Constants/MEDIAINFO_MUX_TYPE.html index f73c812..905f4ae 100644 --- a/doc/html/Constants/MEDIAINFO_MUX_TYPE.html +++ b/doc/html/Constants/MEDIAINFO_MUX_TYPE.html @@ -3,11 +3,11 @@ - MEDIAINFO_MUX_TYPE Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MEDIAINFO_MUX_TYPE Constants Reference

    +

    -
    - - - - -
    Declared inKSYMediaInfo.h
    - @@ -135,7 +128,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -152,7 +145,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -169,7 +162,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -186,7 +179,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -203,7 +196,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -220,7 +213,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -237,7 +230,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -254,7 +247,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -271,7 +264,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -288,7 +281,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -305,7 +298,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -322,7 +315,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -339,7 +332,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -355,14 +348,12 @@

    Constants

    -

    Declared In

    +

    KSYMediaInfo.h

    - -
    diff --git a/doc/html/Constants/MEDIAINFO_SAMPLE_FMT.html b/doc/html/Constants/MEDIAINFO_SAMPLE_FMT.html index 2e5ebd3..d9f7dc8 100644 --- a/doc/html/Constants/MEDIAINFO_SAMPLE_FMT.html +++ b/doc/html/Constants/MEDIAINFO_SAMPLE_FMT.html @@ -3,11 +3,11 @@ - MEDIAINFO_SAMPLE_FMT Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MEDIAINFO_SAMPLE_FMT Constants Reference

    +

    -
    - - - - -
    Declared inKSYMediaInfo.h
    - @@ -133,7 +126,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -150,7 +143,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -167,7 +160,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -184,7 +177,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -201,7 +194,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -218,7 +211,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -235,7 +228,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -252,7 +245,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -269,7 +262,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -286,7 +279,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -303,7 +296,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -320,7 +313,7 @@

    Constants

    - Declared In KSYMediaInfo.h. + KSYMediaInfo.h.

    @@ -336,14 +329,12 @@

    Constants

    -

    Declared In

    +

    KSYMediaInfo.h

    - -
    diff --git a/doc/html/Constants/MPMovieAudioPan.html b/doc/html/Constants/MPMovieAudioPan.html index 9264a40..5a82055 100644 --- a/doc/html/Constants/MPMovieAudioPan.html +++ b/doc/html/Constants/MPMovieAudioPan.html @@ -3,11 +3,11 @@ - MPMovieAudioPan Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieAudioPan Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -115,7 +108,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -132,7 +125,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -149,7 +142,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -165,14 +158,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/MPMovieMetaType.html b/doc/html/Constants/MPMovieMetaType.html index c7c89dc..42620e0 100644 --- a/doc/html/Constants/MPMovieMetaType.html +++ b/doc/html/Constants/MPMovieMetaType.html @@ -3,11 +3,11 @@ - MPMovieMetaType Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieMetaType Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -117,7 +110,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -134,7 +127,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -184,14 +177,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/MPMovieReloadMode.html b/doc/html/Constants/MPMovieReloadMode.html index bcc608f..4f9fb8d 100644 --- a/doc/html/Constants/MPMovieReloadMode.html +++ b/doc/html/Constants/MPMovieReloadMode.html @@ -3,11 +3,11 @@ - MPMovieReloadMode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieReloadMode Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -146,14 +139,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/MPMovieStatus.html b/doc/html/Constants/MPMovieStatus.html index c9ffaf4..18dd9ad 100644 --- a/doc/html/Constants/MPMovieStatus.html +++ b/doc/html/Constants/MPMovieStatus.html @@ -3,11 +3,11 @@ - MPMovieStatus Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieStatus Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -119,7 +112,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -136,7 +129,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -153,7 +146,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -170,7 +163,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -187,7 +180,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -203,14 +196,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/MPMovieVideoDecoderMode.html b/doc/html/Constants/MPMovieVideoDecoderMode.html index 855b1cf..3228e26 100644 --- a/doc/html/Constants/MPMovieVideoDecoderMode.html +++ b/doc/html/Constants/MPMovieVideoDecoderMode.html @@ -3,11 +3,11 @@ - MPMovieVideoDecoderMode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieVideoDecoderMode Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -117,7 +110,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -134,7 +127,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -151,7 +144,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -168,7 +161,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -184,14 +177,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Constants/MPMovieVideoDeinterlaceMode.html b/doc/html/Constants/MPMovieVideoDeinterlaceMode.html index dc6dc9f..888db6a 100644 --- a/doc/html/Constants/MPMovieVideoDeinterlaceMode.html +++ b/doc/html/Constants/MPMovieVideoDeinterlaceMode.html @@ -3,11 +3,11 @@ - MPMovieVideoDeinterlaceMode Constants Reference + - +
    @@ -59,16 +59,9 @@

    -

    MPMovieVideoDeinterlaceMode Constants Reference

    +

    -
    - - - - -
    Declared inKSYMoviePlayerDefines.h
    - @@ -113,7 +106,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -130,7 +123,7 @@

    Constants

    - Declared In KSYMoviePlayerDefines.h. + KSYMoviePlayerDefines.h.

    @@ -146,14 +139,12 @@

    Constants

    -

    Declared In

    +

    KSYMoviePlayerDefines.h

    - -
    diff --git a/doc/html/Protocols/KSYMediaPlayback.html b/doc/html/Protocols/KSYMediaPlayback.html index 237028d..4e8eace 100644 --- a/doc/html/Protocols/KSYMediaPlayback.html +++ b/doc/html/Protocols/KSYMediaPlayback.html @@ -3,11 +3,11 @@ - KSYMediaPlayback Protocol Reference + - +
    @@ -43,42 +43,10 @@

    @@ -91,451 +59,15 @@

    -

    KSYMediaPlayback Protocol Reference

    +

    -
    - - - - -
    Declared inKSYMediaPlayback.h
    - - -
    - -

    Overview

    -

    KSYMediaPlayback为播放内核KSYMoviePlayerController提供播放控制功能。

    - -

    联系我们

    - -

    当本文档无法帮助您解决在开发中遇到的具体问题，请通过以下方式联系我们，金山云工程师会在第一时间回复您。

    - -

    E-mail: zengfanping@kingsoft.com

    -
    - - - - - -
    - - - - - - -
    -
    - -

    – prepareToPlay -required method

    - -
    -
    - -
    - - -
    -

    准备视频播放

    -
    - - - -
    - (void)prepareToPlay
    - - - - - - - - - -
    -

    Discussion

    -

    prepareToPlay处理逻辑

    - -
      -
    • 如果isPreparedToPlay为FALSE，直接调用play，则在play内部自动调用prepareToPlay接口。
      • -
    • prepareToPlay调用后，由MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知完成准备工作。查询isPreparedToPlay可以获得具体属性值。
      • -
    -

    通知类型

    - -
      -
    • MPMediaPlaybackIsPreparedToPlayDidChangeNotification， 播放器完成对视频文件的初始化时发送通知
      • -
    - -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    - -

      isPreparedToPlay -required method

    - -
    -
    - -
    - - -
    -

    查询视频准备是否完成

    -
    - - - -
    @property (nonatomic, readonly) BOOL isPreparedToPlay
    - - - - - - - - -
    -

    Discussion

    -

    isPreparedToPlay处理逻辑

    - -
      -
    • 如果isPreparedToPlay为TRUE，则可以调用play接口开始播放;
      • -
    • 如果isPreparedToPlay为FALSE，则需要调用prepareToPlay接口开始准备工作；
      • -
    • 如果isPreparedToPlay为FALSE，直接调用play，则在play内部自动调用prepareToPlay接口。
      • -
    - -
    - - - - - -
    -

    See Also

    - -
    - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    - -

    – play -required method

    - -
    -
    - -
    - - -
    -

    播放当前视频。

    -
    - - - -
    - (void)play
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMediaPlayback 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    play的使用逻辑:

    - -
      -
    • 如果调用play方法前已经调用prepareToPlay完成播放器对视频文件的初始化，且shouldAutoplay属性为NO，则调用play方法将开始播放当前视频。此时播放器状态为CBPMoviePlaybackStatePlaying。
      • -
    • 如果调用play方法前已经调用prepareToPlay完成播放器对视频文件的初始化，且shouldAutoplay属性为YES，则调用play方法将暂停播放当前视频，实现效果和pause一致。
      • -
    • 如果调用play方法前未调用prepareToPlay完成播放器对视频文件的初始化，则播放器自动调用prepareToPlay进行视频文件的初始化工作。
      • -
    • 如果调用play方法前已经调用pause暂停了正在播放的视频，则重新开始启动播放视频。
      • -
    - -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    - -

    – pause -required method

    - -
    -
    - -
    - - -
    -

    暂停播放当前视频。

    -
    - - - -
    - (void)pause
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMediaPlayback 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    pause调用逻辑：

    - -
      -
    • 如果当前视频播放已经暂停，调用该方法将不产生任何效果。
      • -
    • 重新回到播放状态，需要调用play方法。
      • -
    • 如果调用pause方法后视频暂停播放，此时播放器状态处于CBPMoviePlaybackStatePaused。
      • -
    • 播放器内部监听了UIApplicationWillEnterForegroundNotification通知，该通知发生时如果视频仍然在播放，将自动调用pause暂停当前视频播放。
      • -
    -

    后台播放逻辑：

    - -
      -
    • 需要APP有后台执行权限，在工程Info.plist中添加后台运行模式，设置为audio。具体是添加UIBackgroundModes项，值为audio。
      • -
    • 当用户点击home按钮后，播放器进入后台继续读取数据并播放音频。
      • -
    • 当APP回到前台后，音频继续播放。图像渲染内容保持和音频同步。
      • -
    • 如果在开启后台运行模式后，需要切换后台暂停，需要监听相关事件并主动调用pause操作。
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    - -

    – stop -required method

    - -
    -
    - -
    - - -
    -

    结束当前视频的播放。

    -
    - - - -
    - (void)stop
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMediaPlayback 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    stop调用逻辑：

    - -
      -
    • 调用stop结束当前播放，如果需要重新播放该视频，需要调用prepareToPlay方法。
      • -
    • 调用stop方法后，播放器开始进入关闭当前播放的操作，操作完成将发送MPMoviePlayerPlaybackDidFinishNotification通知。
      • -
    -

    通知：

    - -
      -
    • MPMoviePlayerPlaybackDidFinishNotification， 当播放完成将发送该通知。
      • -
    - -
    - - - - - -
    -

    See Also

    - -
    - - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    - -

      currentPlaybackTime -required method

    - -
    -
    - -
    - - -
    -

    播放视频的当前时刻，单位为秒。

    -
    - - - -
    @property (nonatomic) NSTimeInterval currentPlaybackTime
    - - - - - - - -
    -

    Availability

    -

    Available in KSYMediaPlayback 1.0 and later.

    -
    - - - -
    -

    Discussion

    -

    currentPlaybackTime属性更改时机：

    - -
      -
    • 视频正常播放时，如果改变currentPlaybackTime的值，将导致播放行为跳转到新的currentPlaybackTime位置播放。
      • -
    • 在调用prepareToPlay之前设置该属性的值无效，若希望从指定位置开始播放，需要以下设置 - -
        -
      • 将player的自动播放属性shouldAutoplay设置为NO;
        • -
      • 监听到MPMediaPlaybackIsPreparedToPlayDidChangeNotification通知时，将currentPlaybackTime设置为期望开始播放的时间点，单位是秒
        • -
      • 调用play方法，即可从指定位置开始播放
        • -
      -
      • -
    - -
    - - - - - - - -
    -

    Declared In

    -

    KSYMediaPlayback.h

    -
    - - -
    -
    -
    -
    - -
    - - - - -
    diff --git a/doc/html/css/scss/_index.scss b/doc/html/css/scss/_index.scss index 6a57ec5..7e98029 100644 --- a/doc/html/css/scss/_index.scss +++ b/doc/html/css/scss/_index.scss @@ -1,17 +1,13 @@ .index-container { - -webkit-flex-direction: column; - flex-direction: column; + display: flex; + flex-direction: row; + flex-wrap: wrap; - @media (min-width: $desktop-min-width) { - display: flex; - -webkit-flex-direction: row; - flex-direction: row; - -webkit-flex-wrap: wrap; - flex-wrap: wrap; + @media (max-width: $mobile-max-width) { + flex-direction: column; } .index-column { - -webkit-flex: 1 1 33%; flex: 1 1 33%; } } diff --git a/doc/html/css/scss/_layout.scss b/doc/html/css/scss/_layout.scss index da46aef..40bd6d4 100644 --- a/doc/html/css/scss/_layout.scss +++ b/doc/html/css/scss/_layout.scss @@ -21,10 +21,6 @@ body { font: 62.5% $body-font; background: $body-background; - - @media (max-width: $mobile-max-width) { - background-color: $content-background; - } } h1, h2, h3 { @@ -143,6 +139,8 @@ header { } @media (max-width: $mobile-max-width) { + position: absolute; + .container { padding: 0 10px; } @@ -159,6 +157,10 @@ aside { font-size: 1.1em; + @media (max-width: $mobile-max-width) { + position: absolute; + } + #header-buttons { background: rgba(255, 255, 255, .8); margin: 0 1px; @@ -235,7 +237,6 @@ article { @media (max-width: $mobile-max-width) { padding: 15px 10px 20px 10px; - border: none; } .navigation-top { diff --git a/doc/html/css/scss/_variables.scss b/doc/html/css/scss/_variables.scss index 38e072d..cbaff3c 100644 --- a/doc/html/css/scss/_variables.scss +++ b/doc/html/css/scss/_variables.scss @@ -9,4 +9,3 @@ $object-background: #f9f9f9; $object-border: #e9e9e9; $mobile-max-width: 650px; -$desktop-min-width: 768px; \ No newline at end of file diff --git a/doc/html/css/style.css b/doc/html/css/style.css deleted file mode 100644 index d9d59dd..0000000 --- a/doc/html/css/style.css +++ /dev/null @@ -1,2 +0,0 @@ -html{font-family:sans-serif;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0}article,aside,details,figcaption,figure,footer,header,hgroup,main,menu,nav,section,summary{display:block}audio,canvas,progress,video{display:inline-block;vertical-align:baseline}audio:not([controls]){display:none;height:0}[hidden],template{display:none}a{background-color:transparent}a:active,a:hover{outline:0}abbr[title]{border-bottom:1px dotted}b,strong{font-weight:bold}dfn{font-style:italic}h1{font-size:2em;margin:0.67em 0}mark{background:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative;vertical-align:baseline}sup{top:-0.5em}sub{bottom:-0.25em}img{border:0}svg:not(:root){overflow:hidden}figure{margin:1em 40px}hr{-moz-box-sizing:content-box;box-sizing:content-box;height:0}pre{overflow:auto}code,kbd,pre,samp{font-family:monospace, monospace;font-size:1em}button,input,optgroup,select,textarea{color:inherit;font:inherit;margin:0}button{overflow:visible}button,select{text-transform:none}button,html input[type="button"],input[type="reset"],input[type="submit"]{-webkit-appearance:button;cursor:pointer}button[disabled],html input[disabled]{cursor:default}button::-moz-focus-inner,input::-moz-focus-inner{border:0;padding:0}input{line-height:normal}input[type="checkbox"],input[type="radio"]{box-sizing:border-box;padding:0}input[type="number"]::-webkit-inner-spin-button,input[type="number"]::-webkit-outer-spin-button{height:auto}input[type="search"]{-webkit-appearance:textfield;-moz-box-sizing:content-box;-webkit-box-sizing:content-box;box-sizing:content-box}input[type="search"]::-webkit-search-cancel-button,input[type="search"]::-webkit-search-decoration{-webkit-appearance:none}fieldset{border:1px solid #c0c0c0;margin:0 2px;padding:0.35em 0.625em 0.75em}legend{border:0;padding:0}textarea{overflow:auto}optgroup{font-weight:bold}table{border-collapse:collapse;border-spacing:0}td,th{padding:0}*{box-sizing:border-box}.clear{clear:both}.clearfix:before,.container:before,article #content:before,article #content footer:before,.clearfix:after,.container:after,article #content:after,article #content footer:after{clear:both;display:table;content:""}.xcode .hide-in-xcode{display:none}body{font:62.5% -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;background:#f2f2f2}@media (max-width: 650px){body{background-color:#fff}}h1,h2,h3{font-weight:300;color:#808080}h1{font-size:2em;color:#000}h4{font-size:13px;line-height:1.5;margin:21px 0 0 0}a{color:#08c;text-decoration:none}pre,code{font-family:"Source Code Pro",Monaco,Menlo,Consolas,monospace;word-wrap:break-word}pre>code,.method-declaration code{display:inline-block;font-size:.85em;padding:4px 0 4px 10px;border-left:5px solid rgba(0,155,51,0.2)}pre>code:before,.method-declaration code:before{content:"Objective-C";display:block;font:9px/1 -apple-system-font,"Helvetica Neue",Helvetica,sans-serif;color:#009b33;text-transform:uppercase;letter-spacing:2px;padding-bottom:6px}pre>code{font-size:inherit}table,th,td{border:1px solid #e9e9e9}table{width:100%}th,td{padding:7px}th>:first-child,td>:first-child{margin-top:0}th>:last-child,td>:last-child{margin-bottom:0}.container{max-width:980px;padding:0 10px;margin:0 auto}@media (max-width: 650px){.container{padding:0}}header{position:fixed;top:0;left:0;width:100%;z-index:2;background:#414141;color:#fff;font-size:1.1em;line-height:25px;letter-spacing:.05em}header #library-title{float:left}header #developer-home{float:right}header h1{font-size:inherit;font-weight:inherit;margin:0}header p{margin:0}header h1,header a{color:inherit}@media (max-width: 650px){header .container{padding:0 10px}}aside{position:fixed;top:25px;left:0;width:100%;height:25px;z-index:2;font-size:1.1em}aside #header-buttons{background:rgba(255,255,255,0.8);margin:0 1px;padding:0;list-style:none;text-align:right;line-height:32px}aside #header-buttons li{display:inline-block;cursor:pointer;padding:0 10px}aside #header-buttons label,aside #header-buttons select{cursor:inherit}aside #header-buttons #on-this-page{position:relative}aside #header-buttons #on-this-page .chevron{display:inline-block;width:14px;height:4px;position:relative}aside #header-buttons #on-this-page .chevron .chevy{background:#878787;height:2px;position:absolute;width:10px}aside #header-buttons #on-this-page .chevron .chevy.chevron-left{left:0;transform:rotateZ(45deg) scale(0.6)}aside #header-buttons #on-this-page .chevron .chevy.chevron-right{right:0;transform:rotateZ(-45deg) scale(0.6)}aside #header-buttons #on-this-page #jump-to{opacity:0;font-size:16px;position:absolute;top:5px;left:0;width:100%;height:100%}article{margin-top:25px}article #content{background:#fff;border:1px solid #e9e9e9;padding:15px 25px 30px 25px;font-size:1.4em;line-height:1.45;position:relative}@media (max-width: 650px){article #content{padding:15px 10px 20px 10px;border:none}}article #content .navigation-top{position:absolute;top:15px;right:25px}article #content .title{margin:21px 0 0 0;padding:15px 0}article #content p{color:#414141;margin:0 0 15px 0}article #content th p:last-child,article #content td p:last-child{margin-bottom:0}article #content main ul{list-style:none;margin-left:24px;margin-bottom:12px;padding:0}article #content main ul li{position:relative;padding-left:1.3em}article #content main ul li:before{content:"\02022";color:#414141;font-size:1.08em;line-height:1;position:absolute;left:0;padding-top:2px}article #content footer .footer-copyright{margin:70px 25px 10px 0}article #content footer p{font-size:.71em;color:#a0a0a0}.index-container{-webkit-flex-direction:column;flex-direction:column}@media (min-width: 768px){.index-container{display:flex;-webkit-flex-direction:row;flex-direction:row;-webkit-flex-wrap:wrap;flex-wrap:wrap}}.index-container .index-column{-webkit-flex:1 1 33%;flex:1 1 33%}.section-specification table{width:auto}.section-specification table th{text-align:left}.method-title{margin-left:-15px;margin-bottom:8px;transition:margin-left .3s ease-out}.section-method.hide .method-title{margin-left:0}.method-title code{font-weight:400;font-size:.85em}.method-info{background:#f9f9f9;border-bottom:1px solid #e9e9e9;margin:0 -25px;padding:20px 25px 0 25px;transition:height .3s ease-out;position:relative}.method-info .pointy-thing{background:#fff;height:10px;border-bottom:1px solid #e9e9e9;margin:-20px -25px 16px -25px}.method-info .pointy-thing:before{display:inline-block;content:"";background:#f9f9f9;border:1px solid #e9e9e9;border-bottom:0;border-right:0;position:absolute;left:21px;top:3px;width:12px;height:12px;-webkit-transform:rotate(45deg);transform:rotate(45deg) }.method-info .method-subsection{margin-bottom:15px}.method-info .method-subsection .argument-name{width:1px;text-align:right}.method-info .method-subsection .argument-name code{color:#808080;font-style:italic;font-weight:400}.section-method.hide .method-info{height:0 !important;overflow:hidden;display:none}.section-method.hide.animating .method-info{display:block}.section-method.animating .method-info{overflow:hidden}@media print{body{background:#fff;padding:8px}header{position:static;background:#fff;color:#000}aside{display:none}.container{max-width:none;padding:0}article{margin-top:0}article #content{border:0;background:#fff;padding:15px 0 0 0}article #content .title{margin-top:0;padding-top:0}.method-info,.method-info .pointy-thing{background:#fff}}.xcode header,.xcode aside{display:none}.xcode .container{padding:0}.xcode article{margin-top:0}.xcode article #content{border:0;margin:0}.xcode .method-info,.section-method.hide .xcode .method-info{max-height:auto;overflow:visible}.xcode .method-info.hiding,.section-method.hide .xcode .method-info.hiding{display:block} - diff --git a/doc/html/hierarchy.html b/doc/html/hierarchy.html index f3933c5..e952996 100644 --- a/doc/html/hierarchy.html +++ b/doc/html/hierarchy.html @@ -3,11 +3,11 @@ - KSYLive_iOS Hierarchy + - +
    @@ -38,11 +38,11 @@

    -

    KSYLive_iOS Hierarchy

    +

    -

    Class Hierarchy

    +

    @@ -75,6 +77,8 @@

    Class Hierarchy

  • KSYBeautifyProFilter
    • +
  • KSYMvFilter
    • +
  • KSYSpecialEffects
    • diff --git a/doc/html/index.html b/doc/html/index.html index c737493..c10ec9e 100644 --- a/doc/html/index.html +++ b/doc/html/index.html @@ -3,11 +3,11 @@ - KSYLive_iOS Reference + - +
    @@ -38,7 +38,7 @@

    -

    KSYLive_iOS Reference

    +

    @@ -47,7 +47,7 @@

    KSYLive_iOS Reference

    -

    Class References

    +

    diff --git a/doc/html/js/script.js b/doc/html/js/script.js index 4074361..ca915ee 100644 --- a/doc/html/js/script.js +++ b/doc/html/js/script.js @@ -46,11 +46,10 @@ function fixScrollPosition(element) { info.style.height = (infoContainer.clientHeight + 40) + "px"; fixScrollPosition(element); element.classList.toggle("hide"); - if (element.classList.contains("hide")) { - e.preventDefault(); - } + setTimeout(function() { element.classList.remove("animating"); + info.style.height = "auto"; }, 300); }); }); diff --git a/libksygpulive.podspec b/libksygpulive.podspec index 835e465..109c34d 100644 --- a/libksygpulive.podspec +++ b/libksygpulive.podspec @@ -1,6 +1,6 @@ Pod::Spec.new do |s| s.name = 'libksygpulive' - s.version = '2.7.1' + s.version = '2.8.0' s.license = { :type => 'Proprietary', :text => <<-LICENSE diff --git a/prebuilt/include/KSYStreamer/KSYGPUPicMixer.h b/prebuilt/include/KSYStreamer/KSYGPUPicMixer.h index 796536a..adab5d5 100644 --- a/prebuilt/include/KSYStreamer/KSYGPUPicMixer.h +++ b/prebuilt/include/KSYStreamer/KSYGPUPicMixer.h @@ -94,4 +94,12 @@ */ -(void)clearPicOfLayer:(NSInteger) index; + +/** + @abstract 刷新前是否清除画布 (默认 YES) + @discussion 清除画布就是将画布的每个像素恢复为背景颜色 + @discussion 当存在覆盖整个画布的不透明图层时, 可以将本属性设为NO, 可以节省部分计算资源 + */ +@property (nonatomic, assign) BOOL clearCanvasBeforeDraw; + @end diff --git a/prebuilt/include/KSYStreamer/KSYMvEffect.h b/prebuilt/include/KSYStreamer/KSYMvEffect.h new file mode 100644 index 0000000..6b8a6ad --- /dev/null +++ b/prebuilt/include/KSYStreamer/KSYMvEffect.h @@ -0,0 +1,28 @@ +// +// KSYMvEffect.h +// +// Created by gene on 16/8/17. +// Copyright © 2016年 Cell Phone. All rights reserved. +// + +#import + +/** KSYMvEffect MV特效类 + + * 在原视频上添加上下、左右滑动、黑白等效果，用户可以根据自身需求自定义效果，以shader字符串的形式加载 + * 例如：video -->mvEffect -->mvFilter + + */ +@interface KSYMvEffect : GPUImageFilter +/** + @abstract 初始化并导入effectShader + @param NSString shader + */ +- (id) initWithEffectShader:(NSString *)effectShader; + +/** + 关闭mv effect + */ +- (void)closeMvEffect; + +@end diff --git a/prebuilt/include/KSYStreamer/KSYMvFilter.h b/prebuilt/include/KSYStreamer/KSYMvFilter.h new file mode 100644 index 0000000..cdd72ba --- /dev/null +++ b/prebuilt/include/KSYStreamer/KSYMvFilter.h @@ -0,0 +1,39 @@ +// +// KSYMvFilter.h +// GPUImage +// +// Created by gene on 16/8/29. +// Copyright © 2016年 ksyun. All rights reserved. +// +#import + +/** KSYMvFilter MV效果类 + + * 在原视频上添加mp4素材，用户可以根据自身需求导入mp4素材，展示mv效果 + * 例如：video -->mvFilter + + */ +@interface KSYMvFilter : GPUImageFilterGroup + +@property (nonatomic, retain) GPUImageMovie *MvScreenSource; + +/** + 单个mp4 filter + + @param mp4URL 指定mp4路径 + @param shouldRepeat mp4是否循环播放 + @return mp4 filter + */ +- (id)initWithPath:(NSURL *)mp4URL shouldRepeat:(BOOL)bRepeat; + +/** + 关闭mv filter + */ +- (void)closeMvFilter; + +/** + @abstract mv播放结束回调函数 + */ +@property(nonatomic, copy) void(^mvPlayEndCallback)(); + +@end diff --git a/prebuilt/include/KSYStreamer/KSYTypeDef.h b/prebuilt/include/KSYStreamer/KSYTypeDef.h index 5a742c2..832ce15 100644 --- a/prebuilt/include/KSYStreamer/KSYTypeDef.h +++ b/prebuilt/include/KSYStreamer/KSYTypeDef.h @@ -90,6 +90,8 @@ typedef NS_ENUM(NSUInteger, KSYVideoCodec) { KSYVideoCodec_QY265, /// 视频编码器 - iOS VT264硬件编码器 (iOS 8.0以上支持) KSYVideoCodec_VT264, + /// 视频编码器 - iOS VT265硬件编码器 (iOS 11.0 以上) + KSYVideoCodec_VT265, /// 视频编码器 - 由SDK自动选择（ VT264 > X264） KSYVideoCodec_AUTO = 100, /// 视频编码器 - gif diff --git a/prebuilt/include/KSYStreamer/libksygpufilter.h b/prebuilt/include/KSYStreamer/libksygpufilter.h index e292524..11a52c5 100644 --- a/prebuilt/include/KSYStreamer/libksygpufilter.h +++ b/prebuilt/include/KSYStreamer/libksygpufilter.h @@ -17,3 +17,8 @@ #import "KSYBeautifyProFilter.h" #import "KSYSpecialEffects.h" #import "KSYBuildInSpecialEffects.h" +#import "KSYMvEffect.h" +#import "KSYMvFilter.h" + +#define KSYGPUFILTER_VER 2.8.0 +#define KSYGPUFILTER_ID 9391fe57c987493149de976acc9ff73efd531627 diff --git a/prebuilt/include/KSYStreamer/libksystreamerbase.h b/prebuilt/include/KSYStreamer/libksystreamerbase.h index 7b3e346..ce8d495 100644 --- a/prebuilt/include/KSYStreamer/libksystreamerbase.h +++ b/prebuilt/include/KSYStreamer/libksystreamerbase.h @@ -14,5 +14,5 @@ #import "KSYMessage.h" #import "KSYTranscoder.h" -#define KSYSTREAMERBASE_VER 2.7.1 -#define KSYSTREAMERBASE_ID 4ea976bfb4ad2d1af4c7b75a395d843f841079eb +#define KSYSTREAMERBASE_VER 2.8.0 +#define KSYSTREAMERBASE_ID 1f73cc7e841a5e732946a3f7588d067bdeb5eee6 diff --git a/prebuilt/include/KSYStreamer/libksystreamerengine.h b/prebuilt/include/KSYStreamer/libksystreamerengine.h index 6cc323c..339c944 100644 --- a/prebuilt/include/KSYStreamer/libksystreamerengine.h +++ b/prebuilt/include/KSYStreamer/libksystreamerengine.h @@ -33,6 +33,6 @@ // utils #import "KSYWeakProxy.h" -#define KSYSTREAMERENGINE_VER 0.0.0.0 -#define KSYSTREAMERENGINE_ID 0 +#define KSYSTREAMERENGINE_VER 2.8.0 +#define KSYSTREAMERENGINE_ID d292a58f293fdc69ef9ab40f7457344494bdd687