Skip to content

Commit bb21839

Browse files
committed
Merge branch 'master' of github.com:acrcloud/acrcloud_sdk_ios
2 parents c40a8af + 6694f88 commit bb21839

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
[ACRCloud](https://www.acrcloud.com/) provides services such as **[Music Recognition](https://www.acrcloud.com/music-recognition)**, **[Broadcast Monitoring](https://www.acrcloud.com/broadcast-monitoring/)**, **[Custom Audio Recognition](https://www.acrcloud.com/second-screen-synchronization%e2%80%8b/)**, **[Copyright Compliance & Data Deduplication](https://www.acrcloud.com/copyright-compliance-data-deduplication/)**, **[Live Channel Detection](https://www.acrcloud.com/live-channel-detection/)**, and **[Offline Recognition](https://www.acrcloud.com/offline-recognition/)** etc.<br>
55

66
## Requirements
7-
Follow one of the tutorials to create a project and get your host, access_key and access_secret.
7+
Follow one of the tutorials to create a project and get your host, access_key, and access_secret.
88

99
* [Recognize Music](https://docs.acrcloud.com/tutorials/recognize-music)
1010
* [Recognize Custom Content](https://docs.acrcloud.com/tutorials/recognize-custom-content)
@@ -15,7 +15,7 @@ Follow one of the tutorials to create a project and get your host, access_key an
1515
* [Recognize Live Channels and Custom Content](https://docs.acrcloud.com/tutorials/recognize-tv-channels-and-custom-content)
1616
*
1717
## Identify Music or TV with iOS SDK
18-
This demo shows how to identify music ( songs ) or detect live TV channels by recorded sound with ACRCloud iOS SDK. Contact us if you have any question or special requirement about the SDK: [email protected]
18+
This demo shows how to identify music ( songs ) or detect live TV channels by recorded sound with ACRCloud iOS SDK. Contact us if you have any questions or special requirements about the SDK: [email protected]
1919

2020
## Preparation
2121
* The newest ACRCloud iOS SDK which contains both ObjectC and Swift demo projects.
@@ -27,7 +27,7 @@ This demo shows how to identify music ( songs ) or detect live TV channels by re
2727
## Test the demo
2828
* Download the ACRCloud iOS SDK package and unzip it.
2929
* Open either ACRCloudDemo or ACRCloudDemo_Swift
30-
* Update accessKey, host and accessSecret in ViewController with the information of your project.
30+
* Update accessKey, host, and accessSecret in ViewController with the information of your project.
3131
* Run the demo project to test recognizing contents in the buckets of your project.
3232

3333
## How to use the iOS SDK
@@ -77,32 +77,34 @@ In the progress of recording and detecting, you can stop (click the “Stop” B
7777
```
7878

7979
#### Open Prerecording Recognition
80-
Open prerecording will make the recognition much more faster.
80+
Open prerecording will make the recognition much faster.
8181
If you want open this feature, call "-(void)startPreRecord:(NSInteger)recordTime" before "startRecordRec"
82-
The parameter recordTime is the prerecording time. The recommend value is 3000-4000
82+
The parameter recordTime is the prerecording time. The recommended value is 3000-4000
8383
```
8484
[_client startPreRecord:3000]
8585
```
8686

8787
### Low-Level Function
8888
#### File/PCM/Fingerprint Recognition
89-
if you recongize audio data, the audio format shoud be RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16 bit, mono 8000 Hz, you also can use the resample function to convert the audio data to what we need.
89+
if you recognize audio data or get the audio fingerprint, the audio format should be RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16-bit, mono 8000 Hz, you also can use the resample function to convert the audio data to what we need.
9090
```
9191
-(NSString*)recognize:(char*)buffer len:(int)len;
9292
-(NSString*)recognize:(NSData*)pcm_data;
9393
-(NSString*)recognize_fp:(NSData*)fingerprint;
94+
+(NSData*)get_fingerprint:(NSData*)pcm
95+
+(NSData*)get_fingerprint:(char *)pcm len:(int)len
9496
```
9597
#### Humming Recognition
96-
if you recongize humming data, the audio format shoud be RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16
98+
if you recognize humming data, the audio format should be RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16
9799
bit, mono 8000 Hz, you also can use the resample function to convert the audio data to what we need.
98100
```
99101
//Get humming fingerprint.
100102
+(NSData*)get_hum_fingerprint:(NSData*)pcm;
101-
//recognize humming fingerprint
103+
//recognize the humming fingerprint
102104
-(NSString*)recognize_hum_fp:(NSData*)fingerprint;
103105
```
104106
#### Resample Function
105-
Convert your audio format to RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16 bit, mono 8000 Hz
107+
Convert your audio format to RIFF (little-endian) data, WAVE audio, Microsoft PCM, 16-bit, mono 8000 Hz
106108
```
107109
+(NSData*) resample:(char*)pcm
108110
len:(unsigned)len

0 commit comments

Comments
 (0)