OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsrecordingsFormat View Source
API calls for all endpoints tagged ApiDocsrecordingsFormat.
Link to this section Summary
Functions
Stop a live recording and discard it
Copy a stored recording
Delete a stored recording
List live recordings
Get a stored recording's details
Get the file associated with the stored recording
List recordings that are complete
Mute a live recording. Muting a recording suspends silence detection, which will be restarted when the recording is unmuted
Pause a live recording. Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds
Stop a live recording and store it
Unmute a live recording
Unpause a live recording
Link to this section Functions
cancel(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Stop a live recording and discard it.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
copy_stored(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Copy a stored recording.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording to copy
- destination_recording_name (String.t): The destination name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
delete_stored(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Delete a stored recording.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
get_live(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
List live recordings.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
get_stored(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Get a stored recording's details.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
get_stored_file(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Get the file associated with the stored recording.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
list_stored(Tesla.Env.client(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
List recordings that are complete.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
mute(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Mute a live recording. Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
pause(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Pause a live recording. Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
stop(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Stop a live recording and store it.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
unmute(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Unmute a live recording.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
unpause(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Unpause a live recording.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- recording_name (String.t): The name of the recording
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure