supports_range_api

edgeimpulse_api v1.0.0

edgeimpulse_api.api.supports_range_api module

class edgeimpulse_api.api.supports_range_api.SupportsRangeApi(api_client=None)

Bases: object

get_sample_as_audio(project_id: StrictInt, sample_id: StrictInt, axis_ix: StrictInt, slice_start: Optional[StrictInt] = None, slice_end: Optional[StrictInt] = None, **kwargs)

Get WAV file

Get a sample as a WAV file. This only applies to samples with an audio axis.

• Parameters

  • project_id (int) – Project ID (required)

  • sample_id (int) – Sample ID (required)

  • axis_ix (int) – Axis index (required)

  • slice_start (int) – Begin index of the slice

  • slice_end (int) – End index of the slice

  • async_req (bool*, *optional) – Whether to execute the request asynchronously.

  • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• Returns

  Returns the result object. If the method is called asynchronously, returns the request thread.

• Return type

  str

get_wav_file(project_id: StrictInt, **kwargs)

Get WAV file

Get the synthetic sample as a WAV file

• Parameters

  • project_id (int) – Project ID (required)

  • async_req (bool*, *optional) – Whether to execute the request asynchronously.

  • _preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.

  • _request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.

• Returns

  Returns the result object. If the method is called asynchronously, returns the request thread.

• Return type

  str