twilio.rest.media.v1 package¶
Subpackages¶
Submodules¶
twilio.rest.media.v1.media_processor module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.media.v1.media_processor.
MediaProcessorContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
fetch
()[source]¶ Fetch the MediaProcessorInstance
Returns: The fetched MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorInstance
-
update
(status)[source]¶ Update the MediaProcessorInstance
Parameters: status (MediaProcessorInstance.UpdateStatus) – The status of the MediaProcessor Returns: The updated MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorInstance
-
-
class
twilio.rest.media.v1.media_processor.
MediaProcessorInstance
(version, payload, sid=None)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource 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
-
ended_reason
¶ Returns: The reason why a MediaProcessor ended Return type: unicode
-
extension
¶ Returns: The Media Extension name or URL Return type: unicode
-
extension_context
¶ Returns: The Media Extension context Return type: unicode
-
fetch
()[source]¶ Fetch the MediaProcessorInstance
Returns: The fetched MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorInstance
-
max_duration
¶ Returns: Maximum MediaProcessor duration in seconds Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
status
¶ Returns: The status of the MediaProcessor Return type: MediaProcessorInstance.Status
-
status_callback
¶ Returns: The URL to which Twilio will send MediaProcessor event updates Return type: unicode
-
status_callback_method
¶ Returns: The HTTP method Twilio should use to call the status_callback URL Return type: unicode
-
update
(status)[source]¶ Update the MediaProcessorInstance
Parameters: status (MediaProcessorInstance.UpdateStatus) – The status of the MediaProcessor Returns: The updated MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorInstance
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.media.v1.media_processor.
MediaProcessorList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(extension, extension_context, extension_environment=<object object>, status_callback=<object object>, status_callback_method=<object object>, max_duration=<object object>)[source]¶ Create the MediaProcessorInstance
Parameters: - extension (unicode) – The Media Extension name or URL
- extension_context (unicode) – The Media Extension context
- extension_environment (dict) – The Media Extension environment
- status_callback (unicode) – The URL to send MediaProcessor event updates to your application
- status_callback_method (unicode) – The HTTP method Twilio should use to call the status_callback URL
- max_duration (unicode) – Maximum MediaProcessor duration in minutes
Returns: The created MediaProcessorInstance
Return type:
-
get
(sid)[source]¶ Constructs a MediaProcessorContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.media.v1.media_processor.MediaProcessorContext Return type: twilio.rest.media.v1.media_processor.MediaProcessorContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of MediaProcessorInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorPage
-
list
(order=<object object>, status=<object object>, limit=None, page_size=None)[source]¶ Lists MediaProcessorInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - order (MediaProcessorInstance.Order) – The sort order of the list
- status (MediaProcessorInstance.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_processor.MediaProcessorInstance]
-
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 MediaProcessorInstance records from the API. Request is executed immediately
Parameters: - order (MediaProcessorInstance.Order) – The sort order of the list
- status (MediaProcessorInstance.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 MediaProcessorInstance
Return type:
-
stream
(order=<object object>, status=<object object>, limit=None, page_size=None)[source]¶ Streams MediaProcessorInstance 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 (MediaProcessorInstance.Order) – The sort order of the list
- status (MediaProcessorInstance.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_processor.MediaProcessorInstance]
-
-
class
twilio.rest.media.v1.media_processor.
MediaProcessorPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of MediaProcessorInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.media.v1.media_processor.MediaProcessorInstance Return type: twilio.rest.media.v1.media_processor.MediaProcessorInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.media.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
media_processor
¶ Return type: twilio.rest.media.v1.media_processor.MediaProcessorList
-
media_recording
¶ Return type: twilio.rest.media.v1.media_recording.MediaRecordingList
-
player_streamer
¶ Return type: twilio.rest.media.v1.player_streamer.PlayerStreamerList
-