Twilio.Video.V1.Room.TranscriptionsService (twilio_elixir v0.1.1)

Copy Markdown View Source

transcriptions in video rooms

Operations: list, create, fetch, update

Summary

Functions

Operation: CreateRoomTranscriptions | Tags: VideoV1Transcriptions

Operation: FetchRoomTranscriptions | Tags: VideoV1Transcriptions

Operation: ListRoomTranscriptions | Tags: VideoV1Transcriptions

Stream: (lazy auto-pagination).

Operation: UpdateRoomTranscriptions | Tags: VideoV1Transcriptions

Functions

create(client, room_sid, params \\ %{}, opts \\ [])

@spec create(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Video.V1.Room.Transcriptions.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: CreateRoomTranscriptions | Tags: VideoV1Transcriptions

Optional Parameters

ParameterTypeDescription
ConfigurationobjectA collection of properties that describe transcription behaviour.

fetch(client, room_sid, sid, opts \\ [])

@spec fetch(Twilio.Client.t(), String.t(), String.t(), keyword()) ::
  {:ok, Twilio.Resources.Video.V1.Room.Transcriptions.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: FetchRoomTranscriptions | Tags: VideoV1Transcriptions

list(client, room_sid, params \\ %{}, opts \\ [])

@spec list(Twilio.Client.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Page.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: ListRoomTranscriptions | Tags: VideoV1Transcriptions

stream(client, room_sid, params \\ %{}, opts \\ [])

@spec stream(Twilio.Client.t(), String.t(), map(), keyword()) :: Enumerable.t()

Stream: (lazy auto-pagination).

update(client, room_sid, sid, params \\ %{}, opts \\ [])

@spec update(Twilio.Client.t(), String.t(), String.t(), map(), keyword()) ::
  {:ok, Twilio.Resources.Video.V1.Room.Transcriptions.t()}
  | {:ok, map(), map()}
  | :ok
  | {:error, Twilio.Error.t()}

Operation: UpdateRoomTranscriptions | Tags: VideoV1Transcriptions

Optional Parameters

ParameterTypeDescription
ConfigurationobjectA collection of properties that describe transcription behaviour.
StatusstringValues: started, stopped, failed