twilio.rest.media.v1.media_recording package¶
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.media.v1.media_recording.
MediaRecordingContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
delete
()[source]¶ Deletes the MediaRecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the MediaRecordingInstance
Returns: The fetched MediaRecordingInstance Return type: twilio.rest.media.v1.media_recording.MediaRecordingInstance
-
-
class
twilio.rest.media.v1.media_recording.
MediaRecordingInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
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
-
bitrate
¶ Returns: The bitrate of the media Return type: unicode
-
date_created
¶ Returns: The ISO 8601 date and time in GMT when the resource was created Return type: datetime
-
date_updated
¶ Returns: The ISO 8601 date and time in GMT when the resource was last updated Return type: datetime
-
delete
()[source]¶ Deletes the MediaRecordingInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
duration
¶ Returns: The duration of the MediaRecording Return type: unicode
-
fetch
()[source]¶ Fetch the MediaRecordingInstance
Returns: The fetched MediaRecordingInstance Return type: twilio.rest.media.v1.media_recording.MediaRecordingInstance
-
format
¶ Returns: The format of the MediaRecording Return type: MediaRecordingInstance.Format
-
links
¶ Returns: The URLs of related resources Return type: unicode
-
processor_sid
¶ Returns: The SID of the MediaProcessor Return type: unicode
-
resolution
¶ Returns: The dimensions of the video image in pixels Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
size
¶ Returns: The size of the recording Return type: unicode
-
source_sid
¶ Returns: The SID of the resource that generated the original media Return type: unicode
-
status
¶ Returns: The status of the MediaRecording Return type: MediaRecordingInstance.Status
-
status_callback
¶ Returns: The URL to which Twilio will send MediaRecording event updates Return type: unicode
-
status_callback_method
¶ Returns: The HTTP method Twilio should use to call the status_callback URL Return type: unicode
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
class
-
class
twilio.rest.media.v1.media_recording.
MediaRecordingList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
get
(sid)[source]¶ Constructs a MediaRecordingContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.media.v1.media_recording.MediaRecordingContext Return type: twilio.rest.media.v1.media_recording.MediaRecordingContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of MediaRecordingInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of MediaRecordingInstance Return type: twilio.rest.media.v1.media_recording.MediaRecordingPage
-
list
(order=<object object>, status=<object object>, limit=None, page_size=None)[source]¶ Lists MediaRecordingInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - order (MediaRecordingInstance.Order) – The sort order of the list
- status (MediaRecordingInstance.Status) – Status to filter by
- 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.media.v1.media_recording.MediaRecordingInstance]
-
page
(order=<object object>, status=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of MediaRecordingInstance records from the API. Request is executed immediately
Parameters: - order (MediaRecordingInstance.Order) – The sort order of the list
- status (MediaRecordingInstance.Status) – Status to filter by
- 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 MediaRecordingInstance
Return type:
-
stream
(order=<object object>, status=<object object>, limit=None, page_size=None)[source]¶ Streams MediaRecordingInstance 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: - order (MediaRecordingInstance.Order) – The sort order of the list
- status (MediaRecordingInstance.Status) – Status to filter by
- 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.media.v1.media_recording.MediaRecordingInstance]
-
-
class
twilio.rest.media.v1.media_recording.
MediaRecordingPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
-
get_instance
(payload)[source]¶ Build an instance of MediaRecordingInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.media.v1.media_recording.MediaRecordingInstance Return type: twilio.rest.media.v1.media_recording.MediaRecordingInstance
-