Menu

Expand
Rate this page:

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

Resource Properties in REST API format
sid
sid<MT> Not PII

The unique string that we created to identify the RoomParticipantPublishedTrack resource.

participant_sid
sid<PA> Not PII

The SID of the Participant resource with the published track.

room_sid
sid<RM> Not PII

The SID of the Room resource where the track is published.

name
string Not PII

The track name. Must be no more than 128 characters, and be unique among the participant's published tracks.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

enabled
boolean Not PII

Whether the track is enabled.

kind
enum:kind Not PII

The track type. Can be: audio, video or data.

url
url Not PII

The absolute URL of the resource.

HTTP GET

Returns a single Track resource represented by TrackNameOrSid.

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

Loading Code Sample...
        
        

        Retrieve Track Published by a Participant

        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

        Loading Code Sample...
              
              

              Retrieve Tracks Published 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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

              Loading Code Sample...
                    
                    
                    

                    Thank you for your feedback!

                    Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                    Sending your feedback...
                    🎉 Thank you for your feedback!
                    Something went wrong. Please try again.

                    Thanks for your feedback!

                    thanks-feedback-gif