VideoStreamPlayer
extends Component
in package
Table of Contents
- $attrs : string
- $id : string
- $options : array<string|int, mixed>|null
- $posterUrl : string|null
- $url : string|null
- __construct() : void
- Create a new VideoStreamPlayer component instance.
- render() : View|string
- Get the view / contents that represent the component.
Properties
$attrs
public
string
$attrs
= ''
$id
public
string
$id
$options
public
array<string|int, mixed>|null
$options
= null
$posterUrl
public
string|null
$posterUrl
= null
$url
public
string|null
$url
= null
Methods
__construct()
Create a new VideoStreamPlayer component instance.
public
__construct(string $id[, string|null $url = null ][, string|null $posterUrl = null ][, array<string|int, mixed>|null $options = null ][, string $attrs = '' ]) : void
Parameters
- $id : string
-
The ID of the video element
- $url : string|null = null
-
The URL of the video source (optional)
- $posterUrl : string|null = null
-
The URL of the video poster image (optional)
- $options : array<string|int, mixed>|null = null
-
Video player options array (optional) Supported options:
- autoplay: bool (default: false)
- controls: bool (default: true)
- controlslist: string (default: 'nodownload')
- crossorigin: string (default: 'anonymous')
- disablepictureinpicture: bool (default: true)
- disableremoteplayback: bool (default: true)
- loop: bool (default: false)
- muted: bool (default: false)
- playsinline: bool (default: true)
- preload: string (default: 'metadata')
- $attrs : string = ''
Return values
void —render()
Get the view / contents that represent the component.
public
render() : View|string