<media-airplay-button>

The <media-airplay-button> component is used to bring up the AirPlay menu and select AirPlay playback. The behavior of the <media-airplay-button> will update automatically based on the availability of AirPlay support.

The button will display the contents of the airplay slot, if provided.

NOTE: AirPlay is only available in Safari browsers.

Default usage

<media-controller>
  <video
    playsinline muted crossorigin
    slot="media"
    src="https://stream.mux.com/A3VXy02VoUinw01pwyomEO3bHnG4P32xzV7u1j1FSzjNg/low.mp4"
  ></video>
  <media-airplay-button></media-airplay-button>
</media-controller>

Open Sandbox

Customize icons

You can modify the contents of the <media-airplay-button> component using slots. This is useful if you’d like to use your own custom AirPlay button instead of the default one provided by media-chrome.

Here’s an example of how you can replace the default icon with the string “AIRPLAY”.

<media-controller>
  <video
    playsinline muted crossorigin
    slot="media"
    src="https://stream.mux.com/A3VXy02VoUinw01pwyomEO3bHnG4P32xzV7u1j1FSzjNg/low.mp4"
  ></video>
  <media-airplay-button>
    <span slot="airplay">AIRPLAY</span>
  </media-airplay-button>
</media-controller>

Open Sandbox

Styling with attributes

The <media-airplay-button> doesn’t expose any configuration attributes. However, it will be updated with Media UI Attributes any time the selected caption or subtitle changes.

You can use these attributes to style the button. For example, if airplay is unavailable, hide the button:

media-airplay-button[mediaairplayunavailable] {
  display: none;
}

Reference

Slots

Name	Description
`airplay`	The element shown for the AirPlay button’s display.

Attributes

Name	Type	Description
`disabled`	`boolean`	The Boolean disabled attribute makes the element not mutable or focusable.
`mediacontroller`	`string`	The element `id` of the media controller to connect to (if not nested within).

Media UI Attributes

The media UI attributes will be set automatically by the controller if they are connected via nesting or the mediacontroller attribute. Only set these attributes manually if you know what you're doing.

Name	Type	Description
`mediaairplayunavailable`	`(unavailable\|unsupported)`	Set if airplay is unavailable.

CSS Variables

Name	Default	Description
`--media-airplay-button-display`	`inline-flex`	`display` property of button.
`--media-primary-color`	`rgb(238 238 238)`	Default color of text and icon.
`--media-secondary-color`	`rgb(20 20 30 / .7)`	Default color of button background.
`--media-text-color`	`var(--media-primary-color, rgb(238 238 238))`	`color` of button text.
`--media-icon-color`	`var(--media-primary-color, rgb(238 238 238))`	`fill` color of button icon.
`--media-control-display`		`display` property of control.
`--media-control-background`	`var(--media-secondary-color, rgb(20 20 30 / .7))`	`background` of control.
`--media-control-hover-background`	`rgba(50 50 70 / .7)`	`background` of control hover state.
`--media-control-padding`	`10px`	`padding` of control.
`--media-control-height`	`24px`	`line-height` of control.
`--media-font`	`var(--media-font-weight, bold) var(--media-font-size, 14px) / var(--media-text-content-height, var(--media-control-height, 24px)) var(--media-font-family, helvetica neue, segoe ui, roboto, arial, sans-serif)`	`font` shorthand property.
`--media-font-weight`	`bold`	`font-weight` property.
`--media-font-family`	`helvetica neue, segoe ui, roboto, arial, sans-serif`	`font-family` property.
`--media-font-size`	`14px`	`font-size` property.
`--media-text-content-height`	`var(--media-control-height, 24px)`	`line-height` of button text.
`--media-button-icon-width`		`width` of button icon.
`--media-button-icon-height`	`var(--media-control-height, 24px)`	`height` of button icon.
`--media-button-icon-transform`		`transform` of button icon.
`--media-button-icon-transition`		`transition` of button icon.