twilio.rest.video.v1.recording package

Module contents

This code was generated by / _ _ _| _ _

(_)/(_)(_|/| |(/_ v1.0.0 / /

System Message: WARNING/2 (/twilio/repos/twilio-python/twilio/rest/video/v1/recording/__init__.py:docstring of twilio.rest.video.v1.recording, line 3); backlink

Inline substitution_reference start-string without end-string.
class twilio.rest.video.v1.recording.RecordingContext(version, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

delete()[source]

Deletes the RecordingInstance

Returns:True if delete succeeds, False otherwise
Return type:bool
fetch()[source]

Fetch the RecordingInstance

Returns:The fetched RecordingInstance
Return type:twilio.rest.video.v1.recording.RecordingInstance
class twilio.rest.video.v1.recording.RecordingInstance(version, payload, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Codec[source]

Bases: object

H264 = 'H264'
OPUS = 'OPUS'
PCMU = 'PCMU'
VP8 = 'VP8'
class Format[source]

Bases: object

MKA = 'mka'
MKV = 'mkv'
class Status[source]

Bases: object

COMPLETED = 'completed'
DELETED = 'deleted'
FAILED = 'failed'
PROCESSING = 'processing'
class Type[source]

Bases: object

AUDIO = 'audio'
DATA = 'data'
VIDEO = 'video'
account_sid
Returns:The SID of the Account that created the resource
Return type:unicode
codec
Returns:The codec used to encode the track
Return type:RecordingInstance.Codec
container_format
Returns:The file format for the recording
Return type:RecordingInstance.Format
date_created
Returns:The ISO 8601 date and time in GMT when the resource was created
Return type:datetime
delete()[source]

Deletes the RecordingInstance

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 RecordingInstance

Returns:The fetched RecordingInstance
Return type:twilio.rest.video.v1.recording.RecordingInstance
grouping_sids
Returns:A list of SIDs related to the recording
Return type:dict
Returns:The URLs of related resources
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
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:RecordingInstance.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:RecordingInstance.Type
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.video.v1.recording.RecordingList(version)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a RecordingContext

Parameters:sid – The SID that identifies the resource to fetch
Returns:twilio.rest.video.v1.recording.RecordingContext
Return type:twilio.rest.video.v1.recording.RecordingContext
get_page(target_url)[source]

Retrieve a specific page of RecordingInstance records from the API. Request is executed immediately

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of RecordingInstance
Return type:twilio.rest.video.v1.recording.RecordingPage
list(status=<object object>, source_sid=<object object>, grouping_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, media_type=<object object>, limit=None, page_size=None)[source]

Lists RecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.

Parameters:
  • status (RecordingInstance.Status) – Read only the recordings that have this status
  • source_sid (unicode) – Read only the recordings that have this source_sid
  • grouping_sid (list[unicode]) – Read only recordings that have this grouping_sid
  • date_created_after (datetime) – Read only recordings that started on or after this ISO 8601 date-time with time zone
  • date_created_before (datetime) –

    Read only recordings that started before this ISO 8601 date-time with time zone

  • media_type (RecordingInstance.Type) – Read only recordings that have this media type
  • 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.recording.RecordingInstance]

page(status=<object object>, source_sid=<object object>, grouping_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, media_type=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

Retrieve a single page of RecordingInstance records from the API. Request is executed immediately

Parameters:
  • status (RecordingInstance.Status) – Read only the recordings that have this status
  • source_sid (unicode) – Read only the recordings that have this source_sid
  • grouping_sid (list[unicode]) – Read only recordings that have this grouping_sid
  • date_created_after (datetime) –

    Read only recordings that started on or after this ISO 8601 date-time with time zone

  • date_created_before (datetime) –

    Read only recordings that started before this ISO 8601 date-time with time zone

  • media_type (RecordingInstance.Type) – Read only recordings that have this media type
  • 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 RecordingInstance

Return type:

twilio.rest.video.v1.recording.RecordingPage

stream(status=<object object>, source_sid=<object object>, grouping_sid=<object object>, date_created_after=<object object>, date_created_before=<object object>, media_type=<object object>, limit=None, page_size=None)[source]

Streams RecordingInstance 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 (RecordingInstance.Status) – Read only the recordings that have this status
  • source_sid (unicode) – Read only the recordings that have this source_sid
  • grouping_sid (list[unicode]) – Read only recordings that have this grouping_sid
  • date_created_after (datetime) –

    Read only recordings that started on or after this ISO 8601 date-time with time zone

  • date_created_before (datetime) –

    Read only recordings that started before this ISO 8601 date-time with time zone

  • media_type (RecordingInstance.Type) – Read only recordings that have this media type
  • 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.recording.RecordingInstance]

class twilio.rest.video.v1.recording.RecordingPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of RecordingInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.video.v1.recording.RecordingInstance
Return type:twilio.rest.video.v1.recording.RecordingInstance