Twilio.Insights.V1.Video.RoomService (twilio_elixir v0.1.1)

Copy Markdown View Source

Service for Room API operations.

Operations: list, fetch

Summary

Functions

Get Video Log Analyzer data for a Room.

Get a list of Programmable Video Rooms.

Stream: Get a list of Programmable Video Rooms. (lazy auto-pagination).

Functions

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

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

Get Video Log Analyzer data for a Room.

Operation: FetchVideoRoomSummary | Tags: InsightsV1Room

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

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

Get a list of Programmable Video Rooms.

Operation: ListVideoRoomSummary | Tags: InsightsV1Room

Query Parameters

ParameterTypeDescription
RoomTypearrayType of room. Can be go, peer_to_peer, group, or group_small.
CodecarrayCodecs used by participants in the room. Can be VP8, H264, or VP9.
RoomNamestringRoom friendly name.
CreatedAfterstring (date-time)Only read rooms that started on or after this ISO 8601 timestamp.
CreatedBeforestring (date-time)Only read rooms that started before this ISO 8601 timestamp.

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

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

Stream: Get a list of Programmable Video Rooms. (lazy auto-pagination).