twilio.rest.video.v1 package¶
Subpackages¶
- twilio.rest.video.v1.composition package
- twilio.rest.video.v1.recording package
- twilio.rest.video.v1.room package
- Subpackages
- twilio.rest.video.v1.room.recording package
- twilio.rest.video.v1.room.room_participant package
- Submodules
- twilio.rest.video.v1.room.room_participant.room_participant_anonymize module
- twilio.rest.video.v1.room.room_participant.room_participant_published_track module
- twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule module
- twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track module
- Module contents
- Submodules
- twilio.rest.video.v1.room.room_recording_rule module
- Module contents
- Subpackages
Submodules¶
twilio.rest.video.v1.composition_hook module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.video.v1.composition_hook.
CompositionHookContext
(version, sid)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
delete
()[source]¶ Deletes the CompositionHookInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CompositionHookInstance
Returns: The fetched CompositionHookInstance Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
update
(friendly_name, enabled=<object object>, video_layout=<object object>, audio_sources=<object object>, audio_sources_excluded=<object object>, trim=<object object>, format=<object object>, resolution=<object object>, status_callback=<object object>, status_callback_method=<object object>)[source]¶ Update the CompositionHookInstance
Parameters: - friendly_name (unicode) – A unique string to describe the resource
- enabled (bool) – Whether the composition hook is active
- video_layout (dict) – A JSON object that describes the video layout of the composition hook
- audio_sources (list[unicode]) – An array of track names from the same group room to merge
- audio_sources_excluded (list[unicode]) – An array of track names to exclude
- trim (bool) – Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
- format (CompositionHookInstance.Format) – The container format of the media files used by the compositions created by the composition hook
- resolution (unicode) – A string that describes the columns (width) and rows (height) of the generated composed video in pixels
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
Returns: The updated CompositionHookInstance
Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
-
class
twilio.rest.video.v1.composition_hook.
CompositionHookInstance
(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
-
audio_sources
¶ Returns: The array of track names to include in the compositions created by the composition hook Return type: list[unicode]
-
audio_sources_excluded
¶ Returns: The array of track names to exclude from the compositions created by the composition hook Return type: list[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 CompositionHookInstance
Returns: True if delete succeeds, False otherwise Return type: bool
-
fetch
()[source]¶ Fetch the CompositionHookInstance
Returns: The fetched CompositionHookInstance Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
format
¶ Returns: The container format of the media files used by the compositions created by the composition hook Return type: CompositionHookInstance.Format
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
resolution
¶ Returns: The dimensions of the video image in pixels expressed as columns (width) and rows (height) Return type: unicode
-
sid
¶ Returns: The unique string that identifies the resource Return type: unicode
-
status_callback
¶ Returns: The URL to send status information to your application Return type: unicode
-
status_callback_method
¶ Returns: The HTTP method we should use to call status_callback Return type: unicode
-
update
(friendly_name, enabled=<object object>, video_layout=<object object>, audio_sources=<object object>, audio_sources_excluded=<object object>, trim=<object object>, format=<object object>, resolution=<object object>, status_callback=<object object>, status_callback_method=<object object>)[source]¶ Update the CompositionHookInstance
Parameters: - friendly_name (unicode) – A unique string to describe the resource
- enabled (bool) – Whether the composition hook is active
- video_layout (dict) – A JSON object that describes the video layout of the composition hook
- audio_sources (list[unicode]) – An array of track names from the same group room to merge
- audio_sources_excluded (list[unicode]) – An array of track names to exclude
- trim (bool) – Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
- format (CompositionHookInstance.Format) – The container format of the media files used by the compositions created by the composition hook
- resolution (unicode) – A string that describes the columns (width) and rows (height) of the generated composed video in pixels
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
Returns: The updated CompositionHookInstance
Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.video.v1.composition_hook.
CompositionHookList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
create
(friendly_name, enabled=<object object>, video_layout=<object object>, audio_sources=<object object>, audio_sources_excluded=<object object>, resolution=<object object>, format=<object object>, status_callback=<object object>, status_callback_method=<object object>, trim=<object object>)[source]¶ Create the CompositionHookInstance
Parameters: - friendly_name (unicode) – A unique string to describe the resource
- enabled (bool) – Whether the composition hook is active
- video_layout (dict) – An object that describes the video layout of the composition hook
- audio_sources (list[unicode]) – An array of track names from the same group room to merge
- audio_sources_excluded (list[unicode]) – An array of track names to exclude
- resolution (unicode) – A string that describes the rows (width) and columns (height) of the generated composed video in pixels
- format (CompositionHookInstance.Format) – The container format of the media files used by the compositions created by the composition hook
- status_callback (unicode) – The URL we should call to send status information to your application
- status_callback_method (unicode) – The HTTP method we should use to call status_callback
- trim (bool) – Whether to clip the intervals where there is no active media in the Compositions triggered by the composition hook
Returns: The created CompositionHookInstance
Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
get
(sid)[source]¶ Constructs a CompositionHookContext
Parameters: sid – The SID that identifies the resource to fetch Returns: twilio.rest.video.v1.composition_hook.CompositionHookContext Return type: twilio.rest.video.v1.composition_hook.CompositionHookContext
-
get_page
(target_url)[source]¶ Retrieve a specific page of CompositionHookInstance records from the API. Request is executed immediately
Parameters: target_url (str) – API-generated URL for the requested results page Returns: Page of CompositionHookInstance Return type: twilio.rest.video.v1.composition_hook.CompositionHookPage
-
list
(enabled=<object object>, date_created_after=<object object>, date_created_before=<object object>, friendly_name=<object object>, limit=None, page_size=None)[source]¶ Lists CompositionHookInstance records from the API as a list. Unlike stream(), this operation is eager and will load limit records into memory before returning.
Parameters: - enabled (bool) – Read only CompositionHook resources with an enabled value that matches this parameter
- date_created_after (datetime) – Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only CompositionHook resources created before this ISO 8601 datetime with time zone
- friendly_name (unicode) – Read only CompositionHook resources with friendly names that match this string
- 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.composition_hook.CompositionHookInstance]
-
page
(enabled=<object object>, date_created_after=<object object>, date_created_before=<object object>, friendly_name=<object object>, page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]¶ Retrieve a single page of CompositionHookInstance records from the API. Request is executed immediately
Parameters: - enabled (bool) – Read only CompositionHook resources with an enabled value that matches this parameter
- date_created_after (datetime) – Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only CompositionHook resources created before this ISO 8601 datetime with time zone
- friendly_name (unicode) – Read only CompositionHook resources with friendly names that match this string
- 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 CompositionHookInstance
Return type:
-
stream
(enabled=<object object>, date_created_after=<object object>, date_created_before=<object object>, friendly_name=<object object>, limit=None, page_size=None)[source]¶ Streams CompositionHookInstance 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: - enabled (bool) – Read only CompositionHook resources with an enabled value that matches this parameter
- date_created_after (datetime) – Read only CompositionHook resources created on or after this ISO 8601 datetime with time zone
- date_created_before (datetime) – Read only CompositionHook resources created before this ISO 8601 datetime with time zone
- friendly_name (unicode) – Read only CompositionHook resources with friendly names that match this string
- 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.composition_hook.CompositionHookInstance]
-
-
class
twilio.rest.video.v1.composition_hook.
CompositionHookPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CompositionHookInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.video.v1.composition_hook.CompositionHookInstance Return type: twilio.rest.video.v1.composition_hook.CompositionHookInstance
-
twilio.rest.video.v1.composition_settings module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.video.v1.composition_settings.
CompositionSettingsContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
create
(friendly_name, aws_credentials_sid=<object object>, encryption_key_sid=<object object>, aws_s3_url=<object object>, aws_storage_enabled=<object object>, encryption_enabled=<object object>)[source]¶ Create the CompositionSettingsInstance
Parameters: - friendly_name (unicode) – A descriptive string that you create to describe the resource
- aws_credentials_sid (unicode) – The SID of the stored Credential resource
- encryption_key_sid (unicode) – The SID of the Public Key resource to use for encryption
- aws_s3_url (unicode) – The URL of the AWS S3 bucket where the compositions should be stored
- aws_storage_enabled (bool) – Whether all compositions should be written to the aws_s3_url
- encryption_enabled (bool) – Whether all compositions should be stored in an encrypted form
Returns: The created CompositionSettingsInstance
Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance
-
fetch
()[source]¶ Fetch the CompositionSettingsInstance
Returns: The fetched CompositionSettingsInstance Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance
-
-
class
twilio.rest.video.v1.composition_settings.
CompositionSettingsInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
aws_credentials_sid
¶ Returns: The SID of the stored Credential resource Return type: unicode
-
aws_s3_url
¶ Returns: The URL of the AWS S3 bucket where the compositions are stored Return type: unicode
-
aws_storage_enabled
¶ Returns: Whether all compositions are written to the aws_s3_url Return type: bool
-
create
(friendly_name, aws_credentials_sid=<object object>, encryption_key_sid=<object object>, aws_s3_url=<object object>, aws_storage_enabled=<object object>, encryption_enabled=<object object>)[source]¶ Create the CompositionSettingsInstance
Parameters: - friendly_name (unicode) – A descriptive string that you create to describe the resource
- aws_credentials_sid (unicode) – The SID of the stored Credential resource
- encryption_key_sid (unicode) – The SID of the Public Key resource to use for encryption
- aws_s3_url (unicode) – The URL of the AWS S3 bucket where the compositions should be stored
- aws_storage_enabled (bool) – Whether all compositions should be written to the aws_s3_url
- encryption_enabled (bool) – Whether all compositions should be stored in an encrypted form
Returns: The created CompositionSettingsInstance
Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance
-
encryption_enabled
¶ Returns: Whether all compositions are stored in an encrypted form Return type: bool
-
encryption_key_sid
¶ Returns: The SID of the Public Key resource used for encryption Return type: unicode
-
fetch
()[source]¶ Fetch the CompositionSettingsInstance
Returns: The fetched CompositionSettingsInstance Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.video.v1.composition_settings.
CompositionSettingsList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a CompositionSettingsContext
Returns: twilio.rest.video.v1.composition_settings.CompositionSettingsContext Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsContext
-
-
class
twilio.rest.video.v1.composition_settings.
CompositionSettingsPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of CompositionSettingsInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsInstance
-
twilio.rest.video.v1.recording_settings module¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.video.v1.recording_settings.
RecordingSettingsContext
(version)[source]¶ Bases:
twilio.base.instance_context.InstanceContext
-
create
(friendly_name, aws_credentials_sid=<object object>, encryption_key_sid=<object object>, aws_s3_url=<object object>, aws_storage_enabled=<object object>, encryption_enabled=<object object>)[source]¶ Create the RecordingSettingsInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- aws_credentials_sid (unicode) – The SID of the stored Credential resource
- encryption_key_sid (unicode) – The SID of the Public Key resource to use for encryption
- aws_s3_url (unicode) – The URL of the AWS S3 bucket where the recordings should be stored
- aws_storage_enabled (bool) – Whether all recordings should be written to the aws_s3_url
- encryption_enabled (bool) – Whether all recordings should be stored in an encrypted form
Returns: The created RecordingSettingsInstance
Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance
-
fetch
()[source]¶ Fetch the RecordingSettingsInstance
Returns: The fetched RecordingSettingsInstance Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance
-
-
class
twilio.rest.video.v1.recording_settings.
RecordingSettingsInstance
(version, payload)[source]¶ Bases:
twilio.base.instance_resource.InstanceResource
-
account_sid
¶ Returns: The SID of the Account that created the resource Return type: unicode
-
aws_credentials_sid
¶ Returns: The SID of the stored Credential resource Return type: unicode
-
aws_s3_url
¶ Returns: The URL of the AWS S3 bucket where the recordings are stored Return type: unicode
-
create
(friendly_name, aws_credentials_sid=<object object>, encryption_key_sid=<object object>, aws_s3_url=<object object>, aws_storage_enabled=<object object>, encryption_enabled=<object object>)[source]¶ Create the RecordingSettingsInstance
Parameters: - friendly_name (unicode) – A string to describe the resource
- aws_credentials_sid (unicode) – The SID of the stored Credential resource
- encryption_key_sid (unicode) – The SID of the Public Key resource to use for encryption
- aws_s3_url (unicode) – The URL of the AWS S3 bucket where the recordings should be stored
- aws_storage_enabled (bool) – Whether all recordings should be written to the aws_s3_url
- encryption_enabled (bool) – Whether all recordings should be stored in an encrypted form
Returns: The created RecordingSettingsInstance
Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance
-
encryption_key_sid
¶ Returns: The SID of the Public Key resource used for encryption Return type: unicode
-
fetch
()[source]¶ Fetch the RecordingSettingsInstance
Returns: The fetched RecordingSettingsInstance Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance
-
friendly_name
¶ Returns: The string that you assigned to describe the resource Return type: unicode
-
url
¶ Returns: The absolute URL of the resource Return type: unicode
-
-
class
twilio.rest.video.v1.recording_settings.
RecordingSettingsList
(version)[source]¶ Bases:
twilio.base.list_resource.ListResource
-
get
()[source]¶ Constructs a RecordingSettingsContext
Returns: twilio.rest.video.v1.recording_settings.RecordingSettingsContext Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsContext
-
-
class
twilio.rest.video.v1.recording_settings.
RecordingSettingsPage
(version, response, solution)[source]¶ Bases:
twilio.base.page.Page
-
get_instance
(payload)[source]¶ Build an instance of RecordingSettingsInstance
Parameters: payload (dict) – Payload response from the API Returns: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsInstance
-
Module contents¶
This code was generated by / _ _ _| _ _
(_)/(_)(_|/| |(/_ v1.0.0 / /
-
class
twilio.rest.video.v1.
V1
(domain)[source]¶ Bases:
twilio.base.version.Version
-
composition_hooks
¶ Return type: twilio.rest.video.v1.composition_hook.CompositionHookList
-
composition_settings
¶ Return type: twilio.rest.video.v1.composition_settings.CompositionSettingsList
-
compositions
¶ Return type: twilio.rest.video.v1.composition.CompositionList
-
recording_settings
¶ Return type: twilio.rest.video.v1.recording_settings.RecordingSettingsList
-
recordings
¶ Return type: twilio.rest.video.v1.recording.RecordingList
-
rooms
¶ Return type: twilio.rest.video.v1.room.RoomList
-