You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.en_US.md
+54-54Lines changed: 54 additions & 54 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,14 +16,14 @@
16
16
Charge Type: <b> free of charge </b> </pre>
17
17
18
18
## Reading object
19
-
This document is intended for all developers and testers who use [KSY Live iOS SDK][libksygpulive], and requires readers to have some experience in iOS programming and development, and require readers to read [wiki][wiki] habits.
19
+
This document is intended for all developers and testers who use [KSY Live iOS SDK][libksygpulive], and requires readers to have some experience in iOS programming and development, and require readers to read [wiki][wiki] habits.
[KSY Live iOS SDK][libksygpulive] Jinshan Cloud provides live solution as part of the completion of the iOS audio and video data acquisition, processing, streaming and playback.
29
29
@@ -38,12 +38,12 @@ This document is intended for all developers and testers who use [KSY Live iOS S
38
38
39
39
### 1.1 About Hot Update
40
40
41
-
Jinshan cloud SDK guarantee, provided [Jinshan Cloud Live SDK][libksygpulive] does not use any hot update technology, such as: RN (ReactNative), weex, JSPatch, etc., please rest assured use.
41
+
Kingsoft Cloud guarantees, [KSY Live SDK][libksygpulive] does not use any hot update technology, such as: RN (ReactNative), weex, JSPatch, etc.
42
42
43
43
### 1.2 Push flow function
44
44
-[x] AAC Audio Encoding (Soft and Hard)
45
45
-[x] H.264 video encoding (soft / hardcode supported, baseline / main / high profile supported)
46
-
-[x][H.265 Video Soft Coding](https://github.com/ksvc/KSYLive_iOS/wiki/enableH265)
46
+
-[x][H.265 Video Soft Coding](https://github.com/ksvc/KSYLive_iOS/wiki/enableH265)
47
47
-[x] H.264 video coding (support for soft editing H.264 / H.265 support for H.264 hard coding (baseline / main / high profile support)
48
48
-[x] Multi-resolution encoding support
49
49
-[x] Camera Controls (Toward, Flash, Front and Rear Cameras)
@@ -53,23 +53,23 @@ Jinshan cloud SDK guarantee, provided [Jinshan Cloud Live SDK] [libksygpulive] d
53
53
-[x] Support RTMP streaming live streaming
54
54
-[x] Provides two levels of APIs: easy-to-use kit APIs and flexible component-based APIs that provide open source kit class code
55
55
-[x] Seamless integration with GPUImage
56
-
-[x][Built-in Beauty Filters for GPU Implementation](https://github.com/ksvc/KSYLive_iOS/wiki/filter)
57
-
-[x] Support [Background Music Play](https://github.com/ksvc/KSYLive_iOS/wiki/BGM)
58
-
-[x] Support [Remix](https://github.com/ksvc/KSYLive_iOS/wiki/mixer)
59
-
-[x] Support [Video Motion Switch / Audio Streaming](https://github.com/ksvc/KSYLive_iOS/wiki/pureAudioStream)
60
-
-[x] Support [Backstage](https://github.com/ksvc/KSYLive_iOS/wiki/backgroupStream)
61
-
-[x] Support [Ear Back](https://github.com/ksvc/KSYLive_iOS/wiki/micMonitor)
62
-
-[x] Support [PIP](https://github.com/ksvc/KSYLive_iOS/wiki/pip) Streaming
63
-
-[x] support [preview and capture resolution set separately, support for any resolution](https://github.com/ksvc/KSYLive_iOS/wiki/customOutputSize)
64
-
-[x] Support [3rd party with wheat](https://github.com/ksvc/KSYDiversityLive_iOS/tree/master/agoraRtc)
Kingsoft Cloud SDK guarantees that the provided [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) does not use thermal update technologies such as RN (ReactNative), weex, JSPatch, etc., so be sure to use it.
89
+
Kingsoft Cloud SDK guarantees that the provided [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) does not use thermal update technologies such as RN (ReactNative), weex, JSPatch, etc., so be sure to use it.
90
90
91
91
### 1.5 about the cost
92
-
Kingsoft Cloud SDK guarantees that the provided [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) can be used for commercial applications without charge for any SDK usage. However, other commercial services based on the [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) will be charged by a specific vendor for licensing fees, broadly including:
92
+
Kingsoft Cloud SDK guarantees that the provided [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) can be used for commercial applications without charge for any SDK usage. However, other commercial services based on the [KSYLive iOS Live Broadcast SDK](https://github.com/ksvc/KSYLive_iOS) will be charged by a specific vendor for licensing fees, broadly including:
93
93
94
94
Cloud storage
95
95
CDN distribution
@@ -100,27 +100,27 @@ CDN distribution
100
100
## II. Streaming Events
101
101
### 2.1 2016 release memorabilia
102
102
1. 2016.02.25 uplink network adaptive on-line;
103
-
1. 2016.03.26 [Built-in beauty](https://github.com/ksvc/KSYLive_iOS/wiki/filter) On the line;
104
-
1. 2016.04.11 [Voice](https://github.com/ksvc/KSYLive_iOS/wiki/reverb) that supports four reverb modes is online;
105
-
1. 2016.05.18 [Ear Return](https://github.com/ksvc/KSYLive_iOS/wiki/micMonitor) Go live;
106
-
1. 2016.06.12 [PIP](https://github.com/ksvc/KSYLive_iOS/wiki/pip) Streaming on the line;
103
+
1. 2016.03.26 [Built-in beauty](https://github.com/ksvc/KSYLive_iOS/wiki/filter) On the line;
104
+
1. 2016.04.11 [Voice](https://github.com/ksvc/KSYLive_iOS/wiki/reverb) that supports four reverb modes is online;
105
+
1. 2016.05.18 [Ear Return](https://github.com/ksvc/KSYLive_iOS/wiki/micMonitor) Go live;
106
+
1. 2016.06.12 [PIP](https://github.com/ksvc/KSYLive_iOS/wiki/pip) Streaming on the line;
107
107
1. 2016.06.27 support short video recording;
108
-
1. 2016.08.24 Support [Pure Audio](https://github.com/ksvc/KSYLive_iOS/wiki/pureAudioStream) Streaming, support [Backstage](https://github.com/ksvc/KSYLive_iOS/wiki / backgroupStream), support video dynamic send switch;
109
-
1. 2016.08.31 [Scenario Code](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene) to effectively enhance the live video quality;
110
-
1. 2016.09.07 Built-in [new beauty](https://github.com/ksvc/KSYLive_iOS/wiki/filter) on the line;
111
-
1. 2016.09.12 [kit class top-level code open source](https://github.com/ksvc/KSYLive_iOS/tree/master/source), podspec integrated framework will be changed to integrated static library
108
+
1. 2016.08.24 Support [Pure Audio](https://github.com/ksvc/KSYLive_iOS/wiki/pureAudioStream) Streaming, support [Backstage](https://github.com/ksvc/KSYLive_iOS/wiki / backgroupStream), support video dynamic send switch;
109
+
1. 2016.08.31 [Scenario Code](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene) to effectively enhance the live video quality;
110
+
1. 2016.09.07 Built-in [new beauty](https://github.com/ksvc/KSYLive_iOS/wiki/filter) on the line;
111
+
1. 2016.09.12 [kit class top-level code open source](https://github.com/ksvc/KSYLive_iOS/tree/master/source), podspec integrated framework will be changed to integrated static library
112
112
1. 2016.09.21 special effects filter on the line;
113
-
1. 2016.09.26 [double with wheat](https://github.com/ksvc/KSYDiversityLive_Android/tree/master/Agora) stable version on the line;
114
-
1. 2016.09.28 Video Hardcoding [Performance Encoding Mode](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene) Go live. Audio AAC hard-coded features on the line. Network adaptive scene on the line;
115
-
1. 2016.10.19 Support [Live Streaming Dynamics](https://github.com/ksvc/KSYLive_iOS/wiki/dynamicOrientation);
116
-
1. 2016.10.20 Support [replaykit 屏 屏 流流](https://github.com/ksvc/KSYDiversityLive_iOS/tree/master/KSYReplayKit);
117
-
1. 2016.11.18 Support [Record as mp4 file while streaming](https://github.com/ksvc/KSYLive_iOS/wiki/bypassRecord)
118
-
1. 2016.2.22 Support [Dynamic Frame Rate](https://github.com/ksvc/KSYLive_iOS/wiki/dynamicFPS)
119
-
1. 2016.3.1 support anchor audio [Acquisition voice](http://ksvc.github.io/KSYLive_iOS/doc/html/Classes/KSYAUAudioCapture.html#//api/name/effectTyped)
120
-
1. 2017.3.14 Support [Stereo](https://github.com/ksvc/KSYLive_iOS/wiki/stereo) Streaming
121
-
1. 2017.5.16 Support [Graffiti streaming](https://github.com/ksvc/KSYLive_iOS/wiki/BrushStream)
122
-
1. 2017.7.7 Support [Desktop Recording, Live Streaming](https://github.com/ksvc/KSYAirStreamer_iOS)
123
-
1. 2017.7.7 Support [iOS 11 HEVC Streaming](https://github.com/ksvc/KSYLive_iOS/wiki/enableH265)
113
+
1. 2016.09.26 [double with wheat](https://github.com/ksvc/KSYDiversityLive_Android/tree/master/Agora) stable version on the line;
114
+
1. 2016.09.28 Video Hardcoding [Performance Encoding Mode](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene) Go live. Audio AAC hard-coded features on the line. Network adaptive scene on the line;
115
+
1. 2016.10.19 Support [Live Streaming Dynamics](https://github.com/ksvc/KSYLive_iOS/wiki/dynamicOrientation);
116
+
1. 2016.10.20 Support [replaykit 屏 屏 流流](https://github.com/ksvc/KSYDiversityLive_iOS/tree/master/KSYReplayKit);
117
+
1. 2016.11.18 Support [Record as mp4 file while streaming](https://github.com/ksvc/KSYLive_iOS/wiki/bypassRecord)
118
+
1. 2016.2.22 Support [Dynamic Frame Rate](https://github.com/ksvc/KSYLive_iOS/wiki/dynamicFPS)
119
+
1. 2016.3.1 support anchor audio [Acquisition voice](http://ksvc.github.io/KSYLive_iOS/doc/html/Classes/KSYAUAudioCapture.html#//api/name/effectTyped)
120
+
1. 2017.3.14 Support [Stereo](https://github.com/ksvc/KSYLive_iOS/wiki/stereo) Streaming
121
+
1. 2017.5.16 Support [Graffiti streaming](https://github.com/ksvc/KSYLive_iOS/wiki/BrushStream)
122
+
1. 2017.7.7 Support [Desktop Recording, Live Streaming](https://github.com/ksvc/KSYAirStreamer_iOS)
123
+
1. 2017.7.7 Support [iOS 11 HEVC Streaming](https://github.com/ksvc/KSYLive_iOS/wiki/enableH265)
124
124
1. 2017.8.3 support to collect noise reduction
125
125
126
126
### 2.2 Recent work
@@ -138,12 +138,12 @@ CDN distribution
138
138
### 3.2 download project
139
139
The SDK provides the following access methods:
140
140
141
-
#### 3.2.1 from [github](https://github.com/ksvc/KSYLive_iOS.git) clone
141
+
#### 3.2.1 from [github](https://github.com/ksvc/KSYLive_iOS.git) clone
142
142
143
143
The directory structure is as follows:
144
144
- demo: The demo project is KSYLive, which demonstrates the use of the SDK's main interface
145
145
- doc / docset: appleDoc-style interface document, installed in xcode can see the method and properties of the document
146
-
- doc / html: AppleDoc-style web interface documentation, but also view the [online version](http://ksvc.github.io/KSYLive_iOS/doc/html/index.html)
146
+
- doc / html: AppleDoc-style web interface documentation, but also view the [online version](http://ksvc.github.io/KSYLive_iOS/doc/html/index.html)
147
147
- prebuilt: precompiled library header and library files
148
148
- source: Kit kit source code
149
149
- releaseFramework: Scripts and projects for packaging a precompiled library into an easy-to-integrate framework
@@ -152,7 +152,7 @@ The directory structure is as follows:
#### 3.2.2 From [bitbucket](https://bitbucket.org/ksvc/ksylive_ios.git) clone
155
+
#### 3.2.2 From [bitbucket](https://bitbucket.org/ksvc/ksylive_ios.git) clone
156
156
157
157
For some places to visit slower github circumstances, you can get from the bitbucket clone library content and github consistent.
158
158
`` `
@@ -212,7 +212,7 @@ pod repo update
212
212
213
213
### 3.2.4 GPUImage Dependencies
214
214
215
-
Please refer to [GPUImage](https://github.com/BradLarson/GPUImage/releases/tag/0.1.7) provided by the official cocoapods. The current version of our test is [0.1.7](https: // github. com / BradLarson / GPUImage / releases / tag / 0.1.7)
215
+
Please refer to [GPUImage](https://github.com/BradLarson/GPUImage/releases/tag/0.1.7) provided by the official cocoapods. The current version of our test is [0.1.7](https: // github. com / BradLarson / GPUImage / releases / tag / 0.1.7)
216
216
217
217
### 3.3 to start the demo project
218
218
!!!!! Note: Here are two ways to run the demo, but only one alternative; If you want to change another method, please re-download or decompression, or restore git repository before trying. !!!!!
@@ -261,14 +261,14 @@ Please refer to the help of the script release-libKSYLive.sh (./release-libKSYLi
261
261
Open the demo directory KSYLiveDemo.xcodeproj, modify the configuration file of the KSYLiveDemo project:
262
262
Select KSYLiveDemo project -> select Project KSYLiveDemo-> select Info tab -> select Configurations-> Debug or Release-> to KSYLiveDemo respectively select the corresponding KSYLiveDemo-framework.xcconfig file. Note that if using a dynamic library, select KSYLiveDemo-dy-framework.xcconfig.
The above is the integration method of the static library. For the configuration and usage of the dynamic library, please refer to the content of [Dynamic Library](https://github.com/ksvc/KSYLive_iOS/wiki/dylib) in the Wiki.
271
+
The above is the integration method of the static library. For the configuration and usage of the dynamic library, please refer to the content of [Dynamic Library](https://github.com/ksvc/KSYLive_iOS/wiki/dylib) in the Wiki.
272
272
### 3.4 Add header files to the files that need to use this SDK
0 commit comments