Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

PublishedTrack

The Published Track resource is a subresource of a Participant instance resource. It represents the Tracks a Participant is currently publishing to the Room.

Using the Published Track resource, you can query tracks published to a Room. You can also get a list of Tracks associated with a given Participant.

Published Track Instance Resource

Resource URI

/v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/PublishedTracks/{TrackNameOrSid}

Resource Properties

Names in Node.js format
sid
sid<MT> Not PII

A 34 character string that uniquely identifies this resource.

participantSid
sid<PA> Not PII

Unique Participant identifier that publishes this Track.

roomSid
sid<RM> Not PII

Unique Room identifier where this Track is published.

name
string Not PII

Track name. Limited to 128 characters, must be unique in a Participant’s PublishedTracks.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created, given as a UTC ISO 8601 Timestamp.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated, given as a UTC ISO 8601 Timestamp.

enabled
boolean Not PII

Specifies whether the Track is enabled or not. Boolean.

kind
enum:kind Not PII

Specifies whether Track represents audio, video or data

url
url Not PII

The absolute URL for this resource.

HTTP GET

Returns a single Track resource represented by TrackNameOrSid.

Retrieve a Track published to the Room by a Participant by TrackNameOrSid

        
        
        
        

        HTTP POST

        Not supported.

        Published Track List Resource

        Resource URI

        /v1/Rooms/{RoomNameOrSid}/Participants/{ParticipantIdentityOrSid}/PublishedTracks/
        

        HTTP GET

        Returns a list of tracks associated with a given Participant. The list includes paging information. Only currently Published Tracks are in the list resource.

        Note: No filters supported.

        Retrieve Tracks published to the Room by a Participant

              
              
              
              
              Rate this page:

              Need some help?

              We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.