twilio.rest.video.v1.room.room_participant package

Submodules

twilio.rest.video.v1.room.room_participant.room_participant_published_track module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackContext(version, room_sid, participant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the PublishedTrackInstance

Returns:The fetched PublishedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackInstance
class twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackInstance(version, payload, room_sid, participant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Kind[source]

Bases: object

AUDIO = 'audio'
DATA = 'data'
VIDEO = 'video'
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
enabled
Returns:Whether the track is enabled
Return type:bool
fetch()[source]

Fetch the PublishedTrackInstance

Returns:The fetched PublishedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackInstance
kind
Returns:The track type
Return type:PublishedTrackInstance.Kind
name
Returns:The track name
Return type:unicode
participant_sid
Returns:The SID of the Participant resource with the published track
Return type:unicode
room_sid
Returns:The SID of the Room resource where the track is published
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackList(version, room_sid, participant_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a PublishedTrackContext

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

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of PublishedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackPage
list(limit=None, page_size=None)[source]

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

Parameters:
  • 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.room_participant.room_participant_published_track.PublishedTrackInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 PublishedTrackInstance

Return type:

twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackPage

stream(limit=None, page_size=None)[source]

Streams PublishedTrackInstance 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:
  • 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.room_participant.room_participant_published_track.PublishedTrackInstance]

class twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of PublishedTrackInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackInstance

twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesInstance(version, payload, room_sid, participant_sid)[source]

Bases: twilio.base.instance_resource.InstanceResource

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
participant_sid
Returns:The SID of the Participant resource for the Subscribe Rules
Return type:unicode
room_sid
Returns:The SID of the Room resource for the Subscribe Rules
Return type:unicode
rules
Returns:A collection of Subscribe Rules that describe how to include or exclude matching tracks
Return type:list[unicode]
class twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesList(version, room_sid, participant_sid)[source]

Bases: twilio.base.list_resource.ListResource

fetch()[source]

Fetch the SubscribeRulesInstance

Returns:The fetched SubscribeRulesInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesInstance
update(rules=<object object>)[source]

Update the SubscribeRulesInstance

Parameters:rules (dict) – A JSON-encoded array of subscribe rules
Returns:The updated SubscribeRulesInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesInstance
class twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SubscribeRulesInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesInstance

twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track module

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackContext(version, room_sid, participant_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the SubscribedTrackInstance

Returns:The fetched SubscribedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackInstance
class twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackInstance(version, payload, room_sid, participant_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Kind[source]

Bases: object

AUDIO = 'audio'
DATA = 'data'
VIDEO = 'video'
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
enabled
Returns:Whether the track is enabled
Return type:bool
fetch()[source]

Fetch the SubscribedTrackInstance

Returns:The fetched SubscribedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackInstance
kind
Returns:The track type
Return type:SubscribedTrackInstance.Kind
name
Returns:The track name
Return type:unicode
participant_sid
Returns:The SID of the participant that subscribes to the track
Return type:unicode
publisher_sid
Returns:The SID of the participant that publishes the track
Return type:unicode
room_sid
Returns:The SID of the room where the track is published
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackList(version, room_sid, participant_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a SubscribedTrackContext

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

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of SubscribedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackPage
list(limit=None, page_size=None)[source]

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

Parameters:
  • 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.room_participant.room_participant_subscribed_track.SubscribedTrackInstance]

page(page_token=<object object>, page_number=<object object>, page_size=<object object>)[source]

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

Parameters:
  • 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 SubscribedTrackInstance

Return type:

twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackPage

stream(limit=None, page_size=None)[source]

Streams SubscribedTrackInstance 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:
  • 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.room_participant.room_participant_subscribed_track.SubscribedTrackInstance]

class twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of SubscribedTrackInstance

Parameters:payload (dict) – Payload response from the API
Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackInstance
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackInstance

Module contents

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

(_)/(_)(_|/| |(/_ v1.0.0 / /
class twilio.rest.video.v1.room.room_participant.ParticipantContext(version, room_sid, sid)[source]

Bases: twilio.base.instance_context.InstanceContext

fetch()[source]

Fetch the ParticipantInstance

Returns:The fetched ParticipantInstance
Return type:twilio.rest.video.v1.room.room_participant.ParticipantInstance
published_tracks

Access the published_tracks

Returns:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackList
subscribe_rules

Access the subscribe_rules

Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesList
subscribed_tracks

Access the subscribed_tracks

Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackList
update(status=<object object>)[source]

Update the ParticipantInstance

Parameters:status (ParticipantInstance.Status) – The new status of the resource
Returns:The updated ParticipantInstance
Return type:twilio.rest.video.v1.room.room_participant.ParticipantInstance
class twilio.rest.video.v1.room.room_participant.ParticipantInstance(version, payload, room_sid, sid=None)[source]

Bases: twilio.base.instance_resource.InstanceResource

class Status[source]

Bases: object

CONNECTED = 'connected'
DISCONNECTED = 'disconnected'
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
duration
Returns:Duration of time in seconds the participant was connected
Return type:unicode
end_time
Returns:The time when the participant disconnected from the room in ISO 8601 format
Return type:datetime
fetch()[source]

Fetch the ParticipantInstance

Returns:The fetched ParticipantInstance
Return type:twilio.rest.video.v1.room.room_participant.ParticipantInstance
identity
Returns:The string that identifies the resource’s User
Return type:unicode
Returns:The URLs of related resources
Return type:unicode
published_tracks

Access the published_tracks

Returns:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_published_track.PublishedTrackList
room_sid
Returns:The SID of the participant’s room
Return type:unicode
sid
Returns:The unique string that identifies the resource
Return type:unicode
start_time
Returns:The time of participant connected to the room in ISO 8601 format
Return type:datetime
status
Returns:The status of the Participant
Return type:ParticipantInstance.Status
subscribe_rules

Access the subscribe_rules

Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribe_rule.SubscribeRulesList
subscribed_tracks

Access the subscribed_tracks

Returns:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackList
Return type:twilio.rest.video.v1.room.room_participant.room_participant_subscribed_track.SubscribedTrackList
update(status=<object object>)[source]

Update the ParticipantInstance

Parameters:status (ParticipantInstance.Status) – The new status of the resource
Returns:The updated ParticipantInstance
Return type:twilio.rest.video.v1.room.room_participant.ParticipantInstance
url
Returns:The absolute URL of the resource
Return type:unicode
class twilio.rest.video.v1.room.room_participant.ParticipantList(version, room_sid)[source]

Bases: twilio.base.list_resource.ListResource

get(sid)[source]

Constructs a ParticipantContext

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

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

Parameters:target_url (str) – API-generated URL for the requested results page
Returns:Page of ParticipantInstance
Return type:twilio.rest.video.v1.room.room_participant.ParticipantPage
list(status=<object object>, identity=<object object>, date_created_after=<object object>, date_created_before=<object object>, limit=None, page_size=None)[source]

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

Parameters:
  • status (ParticipantInstance.Status) – Read only the participants with this status
  • identity (unicode) – Read only the Participants with this user identity value
  • date_created_after (datetime) – Read only Participants that started after this date in UTC ISO 8601 format
  • date_created_before (datetime) – Read only Participants that started before this date in ISO 8601 format
  • 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.room_participant.ParticipantInstance]

page(status=<object object>, identity=<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 ParticipantInstance records from the API. Request is executed immediately

Parameters:
  • status (ParticipantInstance.Status) – Read only the participants with this status
  • identity (unicode) – Read only the Participants with this user identity value
  • date_created_after (datetime) – Read only Participants that started after this date in UTC ISO 8601 format
  • date_created_before (datetime) – Read only Participants that started before this date in ISO 8601 format
  • 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 ParticipantInstance

Return type:

twilio.rest.video.v1.room.room_participant.ParticipantPage

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

Streams ParticipantInstance 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 (ParticipantInstance.Status) – Read only the participants with this status
  • identity (unicode) – Read only the Participants with this user identity value
  • date_created_after (datetime) – Read only Participants that started after this date in UTC ISO 8601 format
  • date_created_before (datetime) – Read only Participants that started before this date in ISO 8601 format
  • 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.room_participant.ParticipantInstance]

class twilio.rest.video.v1.room.room_participant.ParticipantPage(version, response, solution)[source]

Bases: twilio.base.page.Page

get_instance(payload)[source]

Build an instance of ParticipantInstance

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