Media Commands
Block commands pertaining to media content.
Last updated
Block commands pertaining to media content.
Last updated
⚙️ Powered by Rock RMS
Like the PlayVideo command, this initiates a full-screen playback of an audio file. Given that it's audio, there won't be much to see.
The CommandParameter
consists of a string that contains the URL of the audio file to be played.
Starting in you can also pass in a PlayAudioParameters
object which contains the following properties.
Property
Type
Description
ThumbnailSource
string
The URL that contains the image to displayed as the thumbnail of the media player. This overrides any embedded artwork found in the metadata.
(See PlayVideoParameters
for more properties)
Examples
This command initiates the playing of a video in full-screen. Usually, it is better to use the MediaPlayer view instead, but there are times you just want to play a video when the user taps a button.
The CommandParameter
consists of a string that contains the URL of the video to be played.
Property
Type
Description
Source
string
The URL of the media to be played.
BackgroundColor
A color to be used behind the media.
Title
string
Overrides any metadata in the media and sets the title text to be displayed.
Subtitle
string
Overrides any metadata in the media and sets the subtitle text to be displayed.
ControlsContent
Contains the view tree that should be used to provide UI controls, this replaces the default controls.
OverlayContent
Contains the view tree that will be displayed over top of the media. The default content only shows for audio files and displays the artwork.
Note that watch map integration is not currently supported with the PlayVideo
command. If this is needed, you'll have to use the Media Player component instead.
Examples
Starting in you can also pass a PlayVideoParameters
object that lets you customize the look of the media player. It contains the following properties.