Sign in

v1

latestOpenAPI 3.1.02026-07-246652306.5 KB
playbackSession

loadStreamUrl

The loadStreamUrl command in the playbackSession namespace loads a streaming (live) radio station URL and optionally starts playback. Upon successful completion, the player sends a playbackStatus event to your app or hardware integration. Your app should subscribe to the playback namespace before sending the loadStreamUrl command to avoid race conditions in receiving playbackStatus or playbackError events.

This command requires that your app has an open playback session with a cloud queue, created or joined using the createSession, joinSession, or joinOrCreateSession command.

If you want to immediately start playing the stream, set the playOnCompletion parameter to true. This bypasses the need to send a play command after the player loads the stream.

post/playbackSessions/{sessionId}/playbackSession/loadStreamUrl

Request body

streamUrlstring required

HTTP URL for the radio station stream. See the supported content types below. Note that you cannot use this command to send an on-demand track for playback.

playOnCompletionboolean nullable

(Optional) If true, the player will start playback after loading the stream URL. If false or not provided, the player remains in the PLAYBACK_IDLE state.

itemIdstring nullable

(Optional) If provided, the player includes this itemId in subsequent playbackStatus and playbackError events corresponding to this stream.

Response

See the x-muse-error-codes extension for a list of muse errors that generate this response

Ok required

This object represents an empty (default) success. The platform returns an empty object ({}).