3.7 KiB
| title | description | ha_category | ha_iot_class | ha_release | ha_quality_scale | ha_domain | ha_integration_type | ha_codeowners | related | ha_config_flow | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Media extractor | Instructions on how to integrate the Media extractor into Home Assistant. |
|
Calculated | 0.49 | internal | media_extractor | integration |
|
|
true |
The Media extractor {% term integration %} gets a stream URL and sends it to a media player entity. This integration can extract entity specific streams if configured accordingly.
{% note %} Media extractor doesn't transcode streams, it just tries to find a stream that matches the requested query. {% endnote %}
{% include integrations/config_flow.md %}
Play media actions
Navigate to the Actions tab inside Developer Tools. From the Actions dropdown menu select media_extractor.play_media and then press the "Fill Example Data" button at the bottom of the page. Use the "Entity ID" dropdown to select your media player and then press the Perform action button.
This will download the file from the given URL.
| Data attribute | Optional | Description |
|---|---|---|
entity_id |
yes | Name(s) of entities to seek media on, e.g., media_player.living_room_chromecast. Defaults to all. |
media_content_id |
no | The ID of the content to play. Platform dependent. |
media_content_type |
no | The type of the content to play. Must be one of MUSIC, TVSHOW, VIDEO, EPISODE, CHANNEL or PLAYLIST MUSIC. |
Extract media URL action
There is also an action that will directly return the URL in the response of the action.
| Data attribute | Optional | Description |
|---|---|---|
url |
no | The URL of the media to extract. |
format_query |
yes | The query that will be used to select the right media. |
Format query
The query can be used to select the right media. Query examples with explanations:
- bestvideo: Best video-only stream
- best: Best video + audio stream
- bestaudio[ext=m4a]: Best audio stream in M4A format
- worst: Worst video + audio stream
- bestaudio[ext=m4a]/bestaudio[ext=ogg]/bestaudio: Best M4A audio, otherwise best OGG audio and only then any best audio
More info about queries can be found here.
Cookies
Some supported video services provide a better experience when you are logged in. For example, if you use Twitch Turbo or are subscribed to a Twitch streamer, logging in prevents the video stream from showing an "An ad is currently playing. Come back after the break." message until the ad is over. Other examples are private or purchased YouTube videos which you can only watch while logged in. You can add a Netscape format cookie file in the Home Assistant configuration directory. The cookie file will be loaded each time a stream is loaded:
config/media_extractor/cookies.txt
To generate the cookie file, you can use a browser extension (like Get Cookies.txt LOCALLY). If you want to create one manually, follow this specification: https://curl.se/rfc/cookie_spec.html.