diff --git a/docs/rfcx-utils/audio.html b/docs/rfcx-utils/audio.html index 786f0d6..e939fec 100644 --- a/docs/rfcx-utils/audio.html +++ b/docs/rfcx-utils/audio.html @@ -3,15 +3,17 @@ - + rfcx-utils.audio API documentation - - - - + + + + + +
@@ -143,9 +145,7 @@

Index

- - \ No newline at end of file diff --git a/docs/rfcx-utils/index.html b/docs/rfcx-utils/index.html index a241c1b..bd8b657 100644 --- a/docs/rfcx-utils/index.html +++ b/docs/rfcx-utils/index.html @@ -3,15 +3,17 @@ - + rfcx-utils API documentation - - - - + + + + + +
@@ -69,9 +71,7 @@

Index

- - \ No newline at end of file diff --git a/docs/rfcx/client.html b/docs/rfcx/client.html index 92d0424..3307a03 100644 --- a/docs/rfcx/client.html +++ b/docs/rfcx/client.html @@ -106,25 +106,21 @@

Args

Returns

List of detections contains stream_id, start, end, confidence, and classification.

-
-def download_audio_file(self, stream, dest_path, start_time, end_time, gain=1, file_ext='wav') +
+def download_segment(self, stream, dest_path, start_time, file_ext)
-

Download single audio. Duration can not be more than 15 minutes.

+

Download single audio file (stream segment).

Args

stream
-
(required) Identifies a stream/site.
+
(required) Identifier for stream/site
dest_path
-
(required) Audio save path.
+
(required) Directory/folder path to save the file
start_time
-
(required) Minimum timestamp to get the audio.
-
end_time
-
(required) Maximum timestamp to get the audio.
-
gain
-
(optional, default = 1) Input channel tone loudness.
+
(required) Exact start timestamp (string or datetime) of the segment
file_ext
-
(optional, default = 'wav') Extension for saving audio files.
+
(optional, default='wav') Audio file extension. Default to wav

Returns

None.

@@ -134,8 +130,8 @@

Raises

if missing required arguements.
-
-def download_audio_files(self, stream, dest_path='./audios', min_date=None, max_date=None, gain=1, file_ext='wav', parallel=True) +
+def download_segments(self, stream, dest_path='./audios', min_date=None, max_date=None, file_ext='wav', parallel=True)

Download multiple audio in giving time range.

@@ -144,17 +140,15 @@

Args

stream
(required) Identifies a stream/site
dest_path
-
(optional, default= './audios') Path to save audio.
+
(optional, default= './audios') Directory/folder path to save the files
min_date
-
(optional, default= None) Minimum timestamp to get the audio. If None then defaults to exactly 30 days ago.
+
(optional, default=None) Minimum timestamp to get the audio. If None then defaults to 30 days ago.
max_date
-
(optional, default= None) Maximum timestamp to get the audio. If None then defaults to now.
-
gain
-
(optional, default= 1) Input channel tone loudness.
+
(optional, default=None) Maximum timestamp to get the audio. If None then defaults to now.
file_ext
-
(optional, default= 'wav') Audio file extension. Default to wav
+
(optional, default='wav') Audio file extension. Default to wav
parallel
-
(optional, default= True) Parallel download audio. Defaults to True.
+
(optional, default=True) Parallel download audio. Defaults to True.

Returns

None.

@@ -241,7 +235,7 @@

Returns

List of audio files contains id, start, end, and file extensions (meta data showing audio id and recorded timestamp).

-def streams(self, organizations=None, projects=None, created_by=None, name=None, keyword=None, only_public=None, only_deleted=None, fields=None, limit=1000, offset=0) +def streams(self, organizations=None, projects=None, created_by=None, name=None, keyword=None, include_public=False, include_deleted=False, fields=None, limit=1000, offset=0)

Retrieve a list of streams

@@ -257,12 +251,12 @@

Args

(optional, default= None) Match exact streams with name (support *)
keyword
(optional, default= None) Match stream name with keyword
-
only_public
-
(optional, default=None) Match public or private streams
-
only_deleted
-
(optional, default=None) Match deleted streams
+
include_public
+
(optional, default=None) Include streams from public projects (that you aren't a member of)
+
include_deleted
+
(optional, default=None) Include deleted streams
fields
-
(optional, default=None) streams information custom retrive fields.
+
(optional, default=None) Specify fields to return (None will choose API default fields)
limit
(optional, default= 1000) Maximum number of results to return
@@ -297,12 +291,12 @@

Index