twilio.rest.video.v1.room.recording package¶
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.video.v1.room.recording.
RoomRecordingContext
(version, room_sid, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the RoomRecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the RoomRecordingInstance
Returns: The fetched RoomRecordingInstance Return type: twilio.rest.video.v1.room.recording.RoomRecordingInstance
-
-
class
twilio.rest.video.v1.room.recording.
RoomRecordingInstance
(version, payload, room_sid, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
class
Status
[source]¶ Bases:
object
-
COMPLETED
= 'completed'¶
-
DELETED
= 'deleted'¶
-
FAILED
= 'failed'¶
-
PROCESSING
= 'processing'¶
-
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
codec
¶ Returns: The codec used for the recording Return type: RoomRecordingInstance.Codec
-
container_format
¶ Returns: The file format for the recording Return type: RoomRecordingInstance.Format
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
delete
()[source]¶ Deletes the RoomRecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
duration
¶ Returns: The duration of the recording in seconds Return type: unicode
-
fetch
()[source]¶ Fetch the RoomRecordingInstance
Returns: The fetched RoomRecordingInstance Return type: twilio.rest.video.v1.room.recording.RoomRecordingInstance
-
links
¶ Returns: The URLs of related resources Return type: unicode
-
media_external_location
¶ Returns: The URL of the media file associated with the recording when stored externally Return type: unicode
-
offset
¶ Returns: The number of milliseconds between a point in time that is common to all rooms in a group and when the source room of the recording started Return type: unicode
-
room_sid
¶ Returns: The SID of the Room resource the recording is associated with Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
size
¶ Returns: The size of the recorded track in bytes Return type: unicode
-
source_sid
¶ Returns: The SID of the recording source Return type: unicode
-
status
¶ Returns: The status of the recording Return type: RoomRecordingInstance.Status
-
track_name
¶ Returns: The name that was given to the source track of the recording Return type: unicode
-
type
¶ Returns: The recording’s media type Return type: RoomRecordingInstance.Type
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
class
-
class
twilio.rest.video.v1.room.recording.
RoomRecordingList
(version, room_sid)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
(sid)[source]¶ Constructs a RoomRecordingContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.video.v1.room.recording.RoomRecordingContext Return type: twilio.rest.video.v1.room.recording.RoomRecordingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of RoomRecordingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of RoomRecordingInstance Return type: twilio.rest.video.v1.room.recording.RoomRecordingPage
-
list
(status=<object object>, source_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, limit=None, page_size=None)[source]¶ Lists RoomRecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - status (RoomRecordingInstance.Status) – Read only the recordings with this status
- source_sid (unicode) – Read only the recordings that have this source_sid
- date_created_after (datetime) – Read only Recordings that started on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only Recordings that started before this ISO 8601 date-time with time zone
- limit (int) – Upper limit for the number of records to return. list() guarantees never to return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, list() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.video.v1.room.recording.RoomRecordingInstance]
-
page
(status=<object object>, source_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of RoomRecordingInstance records from the API. Request is executed immediately
Parameters: - status (RoomRecordingInstance.Status) – Read only the recordings with this status
- source_sid (unicode) – Read only the recordings that have this source_sid
- date_created_after (datetime) – Read only Recordings that started on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only Recordings that started before this ISO 8601 date-time with time zone
- page_token (str) – PageToken provided by the API
- page_number (int) – Page Number, this value is simply for client state
- page_size (int) – Number of records to return, defaults to 50
Returns: Page of RoomRecordingInstance
Return type:
-
stream
(status=<object object>, source_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, limit=None, page_size=None)[source]¶ Streams RoomRecordingInstance records from the API as a generator stream. This operation lazily loads records as efficiently as possible until the limit is reached. The results are returned as a generator, so this operation is memory efficient.
Parameters: - status (RoomRecordingInstance.Status) – Read only the recordings with this status
- source_sid (unicode) – Read only the recordings that have this source_sid
- date_created_after (datetime) – Read only Recordings that started on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only Recordings that started before this ISO 8601 date-time with time zone
- limit (int) – Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit
- page_size (int) – Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)
Returns: Generator that will yield up to limit results
Return type: list[twilio.rest.video.v1.room.recording.RoomRecordingInstance]
-
-
class
twilio.rest.video.v1.room.recording.
RoomRecordingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of RoomRecordingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.video.v1.room.recording.RoomRecordingInstance Return type: twilio.rest.video.v1.room.recording.RoomRecordingInstance
-