Skip to content

Commit b9b0dc0

Browse files
authored
Update README.en_US.md
1 parent a1216a8 commit b9b0dc0

File tree

1 file changed

+54
-54
lines changed

1 file changed

+54
-54
lines changed

README.en_US.md

Lines changed: 54 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,14 @@
1616
Charge Type: <b> free of charge </b> </pre>
1717

1818
## 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.
2020

2121
|![live_1.png](https://raw.githubusercontent.com/wiki/ksvc/KSYLive_iOS/images/live_1.png)|![live_1.png](https://raw.githubusercontent.com/wiki/ksvc/KSYLive_iOS/images/live_2.png)|![live_1.png](https://raw.githubusercontent.com/wiki/ksvc/KSYLive_iOS/images/live_3.png)|
2222

2323
|![live_4.png](https://raw.githubusercontent.com/wiki/ksvc/KSYLive_iOS/images/live_4.png)|![live_5.png](https://raw.githubusercontent.com/wiki/ksvc/KSYLive_iOS/images/live_5.png)|
2424

2525

26-
## One. Features
26+
## 1. Features
2727

2828
[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.
2929

@@ -38,12 +38,12 @@ This document is intended for all developers and testers who use [KSY Live iOS S
3838

3939
### 1.1 About Hot Update
4040

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.
4242

4343
### 1.2 Push flow function
4444
- [x] AAC Audio Encoding (Soft and Hard)
4545
- [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)
4747
- [x] H.264 video coding (support for soft editing H.264 / H.265 support for H.264 hard coding (baseline / main / high profile support)
4848
- [x] Multi-resolution encoding support
4949
- [x] Camera Controls (Toward, Flash, Front and Rear Cameras)
@@ -53,23 +53,23 @@ Jinshan cloud SDK guarantee, provided [Jinshan Cloud Live SDK] [libksygpulive] d
5353
- [x] Support RTMP streaming live streaming
5454
- [x] Provides two levels of APIs: easy-to-use kit APIs and flexible component-based APIs that provide open source kit class code
5555
- [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)
65-
- [x] [Scene Code] (https://github.com/ksvc/KSYLive_iOS/wiki/liveScene)
66-
- [x] Support for soft and hard coded [Performance Coding Mode] (https://github.com/ksvc/KSYLive_iOS/wiki/liveScene)
67-
- [x] Support [Preview & Stream respectively] (https://github.com/ksvc/KSYLive_iOS/wiki/mirrored)
68-
- [x] [Online API Documentation Support] (http://ksvc.github.io/KSYLive_iOS/doc/html/index.html)
69-
- [x] Support [Sidebar] (https://github.com/ksvc/KSYLive_iOS/wiki/bypassRecord), save the video file during the streaming
70-
- [x] Support [Stereo] (https://github.com/ksvc/KSYLive_iOS/wiki/stereo) Streaming (2-channel)
71-
- [x] Support [Doodle Streaming] (https://github.com/ksvc/KSYLive_iOS/wiki/BrushStream)
72-
- [x] Support for [Desktop Recording, Live Tour] (https://github.com/ksvc/KSYAirStreamer_iOS)
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)
65+
- [x] [Scene Code](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene)
66+
- [x] Support for soft and hard coded [Performance Coding Mode](https://github.com/ksvc/KSYLive_iOS/wiki/liveScene)
67+
- [x] Support [Preview & Stream respectively](https://github.com/ksvc/KSYLive_iOS/wiki/mirrored)
68+
- [x] [Online API Documentation Support](http://ksvc.github.io/KSYLive_iOS/doc/html/index.html)
69+
- [x] Support [Sidebar](https://github.com/ksvc/KSYLive_iOS/wiki/bypassRecord), save the video file during the streaming
70+
- [x] Support [Stereo](https://github.com/ksvc/KSYLive_iOS/wiki/stereo) Streaming (2-channel)
71+
- [x] Support [Doodle Streaming](https://github.com/ksvc/KSYLive_iOS/wiki/BrushStream)
72+
- [x] Support for [Desktop Recording, Live Tour](https://github.com/ksvc/KSYAirStreamer_iOS)
7373

7474
### 1.3 playback features
7575
- [x] Consistent with the system player MPMoviePlayerController interface, seamless and fast switching to KSYMediaPlayer;
@@ -82,14 +82,14 @@ Jinshan cloud SDK guarantee, provided [Jinshan Cloud Live SDK] [libksygpulive] d
8282
- [x] Ultra-lightweight live sdk less than 2M;
8383

8484
### 1.4 documentation
85-
[See wiki] (https://github.com/ksvc/KSYLive_iOS/wiki)
85+
[See wiki](https://github.com/ksvc/KSYLive_iOS/wiki)
8686

8787
### 1.4 About Hot Update
8888

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.
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.
9090

9191
### 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:
9393

9494
Cloud storage
9595
CDN distribution
@@ -100,27 +100,27 @@ CDN distribution
100100
## II. Streaming Events
101101
### 2.1 2016 release memorabilia
102102
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;
107107
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
112112
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)
124124
1. 2017.8.3 support to collect noise reduction
125125

126126
### 2.2 Recent work
@@ -138,12 +138,12 @@ CDN distribution
138138
### 3.2 download project
139139
The SDK provides the following access methods:
140140

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
142142

143143
The directory structure is as follows:
144144
- demo: The demo project is KSYLive, which demonstrates the use of the SDK's main interface
145145
- 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)
147147
- prebuilt: precompiled library header and library files
148148
- source: Kit kit source code
149149
- 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:
152152
$ git clone https://github.com/ksvc/KSYLive_iOS.git KSYLive_iOS --depth 1
153153
`` `
154154

155-
#### 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
156156

157157
For some places to visit slower github circumstances, you can get from the bitbucket clone library content and github consistent.
158158
`` `
@@ -212,7 +212,7 @@ pod repo update
212212

213213
### 3.2.4 GPUImage Dependencies
214214

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)
216216

217217
### 3.3 to start the demo project
218218
!!!!! 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
261261
Open the demo directory KSYLiveDemo.xcodeproj, modify the configuration file of the KSYLiveDemo project:
262262
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.
263263

264-
! [xcode_configs] (https://github.com/ksvc/KSYLive_iOS/wiki/images/xcode_configs.png)
264+
! [xcode_configs](https://github.com/ksvc/KSYLive_iOS/wiki/images/xcode_configs.png)
265265

266266
Or manually add the following parameters in the project configuration: (For details, see KSYLiveDemo-framework.xcconfig in the demo directory)
267267
`` `
268268
OTHER_LDFLAGS = $ (inherited) -ObjC -all_load -framework libksygpulive -framework GPUImage -framework Bugly -lstdc ++. 6 -lz
269269
FRAMEWORK_SEARCH_PATHS = $ (inherited) ../framework/ ../framework/static
270270
`` `
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.
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.
272272
### 3.4 Add header files to the files that need to use this SDK
273273
`` `
274274
#import <GPUImage / GPUImage.h>
@@ -288,7 +288,7 @@ NSLog (@ "version:% @", [kit getKSYVersion]);
288288
`` `
289289

290290
### 3.6 Precautions when integrating
291-
* This framework already includes [Play SDK] (https://github.com/ksvc/KSYMediaPlayer_iOS.git)
291+
* This framework already includes [Play SDK](https://github.com/ksvc/KSYMediaPlayer_iOS.git)
292292
And will have a conflict with the playback SDK, before integration, please ensure that the previously integrated KSY playback SDK is removed
293293
* This framework may conflict with other static libraries that use FFmpeg (conflict may consider using dynamic libraries)
294294
* This framework is a static library, although the size of the library is 20M +, but after the last link, the increment of the app is only 5M +
@@ -298,9 +298,9 @@ pod repo update
298298
`` `
299299

300300
## four reference documents
301-
* [iOS Streaming SDK User Guide] (https://github.com/ksvc/KSYLive_iOS/wiki/KSYStreamerSDKUserManual)
302-
* [iOS Live Streaming SDK Frequently Asked Questions] (https://github.com/ksvc/KSYLive_iOS/wiki/FAQ)
303-
* [Interface Change History] (https://github.com/ksvc/KSYLive_iOS/wiki/apiAdjust)
301+
* [iOS Streaming SDK User Guide](https://github.com/ksvc/KSYLive_iOS/wiki/KSYStreamerSDKUserManual)
302+
* [iOS Live Streaming SDK Frequently Asked Questions](https://github.com/ksvc/KSYLive_iOS/wiki/FAQ)
303+
* [Interface Change History](https://github.com/ksvc/KSYLive_iOS/wiki/apiAdjust)
304304

305305
## V. player usage examples
306306
See the github library at https://github.com/ksvc/KSYMediaPlayer_iOS.git
@@ -319,7 +319,7 @@ Problem Description | Description of the problem
319319
Extra Attachments | Textual Forms Console log, crash reports, other ancillary information (screen shots or videos, etc.) |
320320

321321
### 6.2 Contact information
322-
* Homepage: [Jinshan cloud] (http://www.ksyun.com/)
322+
* Homepage: [Jinshan cloud](http://www.ksyun.com/)
323323
* E-mail: <zengfanping@kingsoft.com>
324324
* QQ discussion group:
325325
    * 574179720 [video cloud technology exchange group]

0 commit comments

Comments
 (0)