OSTIP_EXARI v0.1.0 Swagger.Client.Api.ApiDocsplaybacksFormat View Source
API calls for all endpoints tagged ApiDocsplaybacksFormat.
Link to this section Summary
Link to this section Functions
Link to this function
control(connection, playback_id, operation, opts \\ [])
View Source
control(Tesla.Env.client(), String.t(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Control a playback.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- playback_id (String.t): Playback's id
- operation (String.t): Operation to perform on the playback.
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
Link to this function
get(connection, playback_id, opts \\ [])
View Source
get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Get a playback's details.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- playback_id (String.t): Playback's id
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure
Link to this function
stop(connection, playback_id, opts \\ [])
View Source
stop(Tesla.Env.client(), String.t(), keyword()) :: {:ok, nil} | {:error, Tesla.Env.t()}
Stop a playback.
Parameters
- connection (Swagger.Client.Connection): Connection to server
- playback_id (String.t): Playback's id
- opts (KeywordList): [optional] Optional parameters
Returns
{:ok, %{}} on success {:error, info} on failure