core/homeassistant/components/media_player/services.yaml

277 lines
6.0 KiB
YAML

# Describes the format for available media player services
turn_on:
name: Turn on
description: Turn a media player power on.
target:
entity:
domain: media_player
turn_off:
name: Turn off
description: Turn a media player power off.
target:
entity:
domain: media_player
toggle:
name: Toggle
description: Toggles a media player power state.
target:
entity:
domain: media_player
volume_up:
name: Turn up volume
description: Turn a media player volume up.
target:
entity:
domain: media_player
volume_down:
name: Turn down volume
description: Turn a media player volume down.
target:
entity:
domain: media_player
volume_mute:
name: Mute volume
description: Mute a media player's volume.
target:
entity:
domain: media_player
fields:
is_volume_muted:
name: Muted
description: True/false for mute/unmute.
required: true
selector:
boolean:
volume_set:
name: Set volume
description: Set a media player's volume level.
target:
entity:
domain: media_player
fields:
volume_level:
name: Level
description: Volume level to set as float.
required: true
selector:
number:
min: 0
max: 1
step: 0.01
media_play_pause:
name: Play/Pause
description: Toggle media player play/pause state.
target:
entity:
domain: media_player
media_play:
name: Play
description: Send the media player the command for play.
target:
entity:
domain: media_player
media_pause:
name: Pause
description: Send the media player the command for pause.
target:
entity:
domain: media_player
media_stop:
name: Stop
description: Send the media player the stop command.
target:
entity:
domain: media_player
media_next_track:
name: Next
description: Send the media player the command for next track.
target:
entity:
domain: media_player
media_previous_track:
name: Previous
description: Send the media player the command for previous track.
target:
entity:
domain: media_player
media_seek:
name: Seek
description: Send the media player the command to seek in current playing media.
target:
entity:
domain: media_player
fields:
seek_position:
name: Position
description: Position to seek to. The format is platform dependent.
required: true
selector:
number:
min: 0
max: 9223372036854775807
step: 0.01
mode: box
play_media:
name: Play media
description: Send the media player the command for playing media.
target:
entity:
domain: media_player
fields:
media_content_id:
name: Content ID
description: The ID of the content to play. Platform dependent.
required: true
example: "https://home-assistant.io/images/cast/splash.png"
selector:
text:
media_content_type:
name: Content type
description:
The type of the content to play. Like image, music, tvshow, video,
episode, channel or playlist.
required: true
example: "music"
selector:
text:
enqueue:
name: Enqueue
description: If the content should be played now or be added to the queue.
required: false
selector:
select:
options:
- label: "Play now"
value: "play"
- label: "Play next"
value: "next"
- label: "Add to queue"
value: "add"
- label: "Play now and clear queue"
value: "replace"
announce:
name: Announce
description: If the media should be played as an announcement.
required: false
example: "true"
selector:
boolean:
select_source:
name: Select source
description: Send the media player the command to change input source.
target:
entity:
domain: media_player
fields:
source:
name: Source
description: Name of the source to switch to. Platform dependent.
required: true
example: "video1"
selector:
text:
select_sound_mode:
name: Select sound mode
description: Send the media player the command to change sound mode.
target:
entity:
domain: media_player
fields:
sound_mode:
name: Sound mode
description: Name of the sound mode to switch to.
example: "Music"
selector:
text:
clear_playlist:
name: Clear playlist
description: Send the media player the command to clear players playlist.
target:
entity:
domain: media_player
shuffle_set:
name: Shuffle
description: Set shuffling state.
target:
entity:
domain: media_player
fields:
shuffle:
name: Shuffle
description: True/false for enabling/disabling shuffle.
required: true
selector:
boolean:
repeat_set:
name: Repeat
description: Set repeat mode
target:
entity:
domain: media_player
fields:
repeat:
name: Repeat mode
description: Repeat mode to set.
required: true
selector:
select:
options:
- label: "Off"
value: "off"
- label: "Repeat all"
value: "all"
- label: "Repeat one"
value: "one"
join:
name: Join
description:
Group players together. Only works on platforms with support for player
groups.
target:
entity:
domain: media_player
fields:
group_members:
name: Group members
description: The players which will be synced with the target player.
required: true
example: |
- media_player.multiroom_player2
- media_player.multiroom_player3
selector:
entity:
multiple: true
domain: media_player
unjoin:
description:
Unjoin the player from a group. Only works on platforms with support for
player groups.
name: Unjoin
target:
entity:
domain: media_player