View Source Fishjam.Recording (Fishjam Server SDK v0.6.0)

Utilites for manipulating the recordings.

Examples

iex> client = Fishjam.Client.new()
iex> assert {:ok, []} = Fishjam.Recording.get_list(client)
iex> assert {:error, "Request failed: Recording not found"} = Fishjam.Recording.delete(client, "not_exisiting_recording")

Summary

Types

Id for the recording, unique within Fishjam instance.

Functions

Deletes the recording with id.

Lists all available recordings.

Types

@type id() :: String.t()

Id for the recording, unique within Fishjam instance.

Functions

@spec delete(Fishjam.Client.t(), id()) :: :ok | {:error, String.t()}

Deletes the recording with id.

@spec get_list(Fishjam.Client.t()) :: {:ok, [id()]} | {:error, String.t()}

Lists all available recordings.