ngx-agora
Version:
Angular wrapper for Agora RTC client (https://www.agora.io/en/)
30 lines (29 loc) • 1.45 kB
TypeScript
/**
* Options for playing an Agora.io media stream.
*/
export interface VideoPlayOptions {
/**
* Video display mode:
* - `'cover'`: Uniformly scale the video until it fills the visible boundaries (cropped).
* One dimension of the video may have clipped contents. Refer to the cover option of object-fit in CSS.
* - `'contain'`: Uniformly scale the video until one of its dimension fits the boundary (zoomed to fit).
* Areas that are not filled due to the disparity in the aspect ratio will be filled with black.
* Refer to the contain option of object-fit in CSS.
*
* For local streams, by default the cover mode is used for video playing and the contain mode is used for screen sharing;
* for remote streams, by default the cover mode is used.
*/
fit?: 'cover' | 'contain';
/**
* Sets whether to mute the playing stream.
*
* The `muted` flag can be used as a workaround for the browser's autoplay policy.
*
* On Chrome 70+ and Safari, a video stream with sound does not play until triggered by a user gesture.
* If you want to play the video anyway without a user gesture, you can set the muted flag to true, so that the video is
* automatically played without sound.
*
* @see [Autoplay Policy Changes](https://developers.google.com/web/updates/2017/09/autoplay-policy-changes) for more information.
*/
muted?: boolean;
}