src/app/openvidu-webcomponent/openvidu-webcomponent.component.ts
OpenviduWebComponentComponent is a wrapper of the VideoconferenceComponent which allows to generate and export the OpenVidu Webcomponent. It is not included in the library.
| templateUrl | ./openvidu-webcomponent.component.html |
| activitiesPanelBroadcastingActivity |
Type : string | boolean
|
|
The activitiesPanelBroadcastingActivity attribute allows show/hide the broadcasting activity in ActivitiesPanelComponent. Default: |
| activitiesPanelRecordingActivity |
Type : string | boolean
|
|
The activitiesPanelRecordingActivity attribute allows show/hide the recording activity in ActivitiesPanelComponent. Default: |
| broadcastingActivityBroadcastingError |
Type : any
|
|
The broadcastingActivityBroadcastingError attribute allows to show any possible error with the broadcasting in the BroadcastingActivityComponent. Default: |
| captionsLang |
Type : string
|
|
The captionsLang attribute sets the deafult language that OpenVidu will try to recognise. It must be a valid BCP-47 language tag like "en-US" or "es-ES". Default: |
| captionsLangOptions |
Type : string | []
|
|
The captionsLangOptions attribute sets the language options for the captions. It will override the languages provided by default. This propety is an array of objects which must comply with the CaptionsLangOption interface. Default: |
| lang |
Type : string
|
|
The lang attribute sets the default UI language. Default: |
| langOptions |
Type : string | []
|
|
The langOptions directive allows to set the application language options. It will override the application languages provided by default. This propety is an array of objects which must comply with the LangOption interface. It is only available for VideoconferenceComponent. Default: Note: If you want to add a new language, you must add a new object with the name and the language code (e.g. |
| minimal |
Type : string | boolean
|
|
The minimal attribute applies a minimal UI hiding all controls except for cam and mic. Default: |
| participantName |
Type : string
|
|
The participantName attribute sets the participant name. It can be useful for aplications which doesn't need the prejoin page.
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
|
| prejoin |
Type : string | boolean
|
|
The prejoin attribute allows show/hide the prejoin page for selecting media devices. Default: |
| recordingActivityRecordingError |
Type : any
|
|
The recordingActivityRecordingError attribute allows to show any possible error with the recording in the RecordingActivityComponent. Default: |
| recordingActivityRecordingsList |
Type : RecordingInfo[]
|
|
The recordingActivityRecordingList attribute allows show to show the recordings available for the session in RecordingActivityComponent. Default: |
| streamFrameRate |
Type : number
|
|
The frameRate directive allows initialize the publisher with a specific frame rate in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
|
| streamResolution |
Type : string
|
|
The resolution directive allows to set a specific participant resolution in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
|
| tokens |
Type : TokenModel | string
|
|
Tokens parameter is required to grant a participant access to a Session. This OpenVidu token will be use by each participant when connecting to a Session. This input accepts a TokenModel object type or a string type. |
| onActivitiesPanelDeleteRecordingClicked |
Type : EventEmitter<string>
|
|
Provides event notifications that fire when delete recording button is clicked from ActivitiesPanelComponent. The recording should be deleted using the REST API. |
| onActivitiesPanelDownloadRecordingClicked |
Type : EventEmitter<string>
|
|
Provides event notifications that fire when download recording button is clicked from ActivitiesPanelComponent. The recording should be downloaded using the REST API. |
| onActivitiesPanelStartBroadcastingClicked |
Type : EventEmitter<string>
|
|
Provides event notifications that fire when start broadcasting button is clicked ActivitiesPanelComponent. The broadcasting should be started using the REST API. |
| onActivitiesPanelStartRecordingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when start recording button is clicked ActivitiesPanelComponent. The recording should be started using the REST API. |
| onActivitiesPanelStopBroadcastingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when stop broadcasting button is clicked ActivitiesPanelComponent. The broadcasting should be stopped using the REST API. |
| onActivitiesPanelStopRecordingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when stop recording button is clicked from ActivitiesPanelComponent. The recording should be stopped using the REST API. |
| onJoinButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when join button (in prejoin page) has been clicked. |
| onParticipantCreated |
Type : EventEmitter<ParticipantAbstractModel>
|
|
Provides event notifications that fire when local participant is created. |
| onSessionCreated |
Type : EventEmitter<Session>
|
|
Provides event notifications that fire when OpenVidu Session is created. See openvidu-browser Session. |
| onToolbarActivitiesPanelButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when activities panel button has been clicked. |
| onToolbarCameraButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when camera toolbar button has been clicked. |
| onToolbarChatPanelButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when chat panel button has been clicked. |
| onToolbarFullscreenButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when fullscreen toolbar button has been clicked. |
| onToolbarLeaveButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when leave button has been clicked. |
| onToolbarMicrophoneButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when microphone toolbar button has been clicked. |
| onToolbarParticipantsPanelButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when participants panel button has been clicked. |
| onToolbarScreenshareButtonClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when screenshare toolbar button has been clicked. |
| onToolbarStartRecordingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when start recording button is clicked from ToolbarComponent. The recording should be started using the REST API. |
| onToolbarStopBroadcastingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when stop broadcasting button is clicked from ToolbarComponent. The recording should be stopped using the REST API. |
| onToolbarStopRecordingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when stop recording button is clicked from ToolbarComponent. The recording should be stopped using the REST API. |
| _onToolbarActivitiesPanelButtonClicked |
_onToolbarActivitiesPanelButtonClicked()
|
|
Returns :
void
|
| disconnect |
disconnect()
|
|
Returns :
void
|
| minimal | ||||||
setminimal(value: string | boolean)
|
||||||
|
The minimal attribute applies a minimal UI hiding all controls except for cam and mic. Default:
Parameters :
Example :
Returns :
void
|
| lang | ||||||
setlang(value: string)
|
||||||
|
The lang attribute sets the default UI language. Default:
Parameters :
Example :
Returns :
void
|
| captionsLang | ||||||
setcaptionsLang(value: string)
|
||||||
|
The captionsLang attribute sets the deafult language that OpenVidu will try to recognise. It must be a valid BCP-47 language tag like "en-US" or "es-ES". Default:
Parameters :
Example :
Returns :
void
|
| langOptions | ||||||
setlangOptions(value: string | LangOption[])
|
||||||
|
The langOptions directive allows to set the application language options. It will override the application languages provided by default. This propety is an array of objects which must comply with the LangOption interface. It is only available for VideoconferenceComponent. Default: Note: If you want to add a new language, you must add a new object with the name and the language code (e.g.
Parameters :
Example :
Returns :
void
|
| captionsLangOptions | ||||||
setcaptionsLangOptions(value: string | CaptionsLangOption[])
|
||||||
|
The captionsLangOptions attribute sets the language options for the captions. It will override the languages provided by default. This propety is an array of objects which must comply with the CaptionsLangOption interface. Default:
Parameters :
Example :
Returns :
void
|
| participantName | ||||||
setparticipantName(value: string)
|
||||||
|
The participantName attribute sets the participant name. It can be useful for aplications which doesn't need the prejoin page.
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| prejoin | ||||||
setprejoin(value: string | boolean)
|
||||||
|
The prejoin attribute allows show/hide the prejoin page for selecting media devices. Default:
Parameters :
Example :
Returns :
void
|
| videoMuted | ||||||
setvideoMuted(value: string | boolean)
|
||||||
|
The videoMuted attribute allows to join the session with camera muted/unmuted. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| audioMuted | ||||||
setaudioMuted(value: string | boolean)
|
||||||
|
The audioMuted attribute allows to join the session with microphone muted/unmuted. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| simulcast | ||||||
setsimulcast(value: string | boolean)
|
||||||
|
The simulcast directive allows to enable/disable the Simulcast feature. Simulcast is a technique that allows to send multiple versions of the same video stream at different resolutions, framerates and qualities. This way, the receiver can subscribe to the most appropriate stream for its current network conditions. Default:
Parameters :
Example :
Returns :
void
|
| toolbarScreenshareButton | ||||||
settoolbarScreenshareButton(value: string | boolean)
|
||||||
|
The toolbarScreenshareButton attribute allows show/hide the screenshare toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarRecordingButton | ||||||
settoolbarRecordingButton(value: string | boolean)
|
||||||
|
The toolbarRecordingButton attribute allows show/hide the start/stop recording toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarBroadcastingButton | ||||||
settoolbarBroadcastingButton(value: string | boolean)
|
||||||
|
The toolbarBroadcastingButton attribute allows show/hide the start/stop broadcasting toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarFullscreenButton | ||||||
settoolbarFullscreenButton(value: string | boolean)
|
||||||
|
The toolbarFullscreenButton attribute allows show/hide the fullscreen toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarBackgroundEffectsButton | ||||||
settoolbarBackgroundEffectsButton(value: string | boolean)
|
||||||
|
The toolbarBackgroundEffectsButton attribute allows show/hide the background effects toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarSettingsButton | ||||||
settoolbarSettingsButton(value: string | boolean)
|
||||||
|
The toolbarSettingsButton attribute allows show/hide the settings toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarLeaveButton | ||||||
settoolbarLeaveButton(value: string | boolean)
|
||||||
|
The toolbarLeaveButton attribute allows show/hide the leave toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarChatPanelButton | ||||||
settoolbarChatPanelButton(value: string | boolean)
|
||||||
|
The toolbarChatPanelButton attribute allows show/hide the chat panel toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarActivitiesPanelButton | ||||||
settoolbarActivitiesPanelButton(value: string | boolean)
|
||||||
|
The toolbarActivitiesPanelButton attribute allows show/hide the activities panel toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarParticipantsPanelButton | ||||||
settoolbarParticipantsPanelButton(value: string | boolean)
|
||||||
|
The toolbarParticipantsPanelButton attribute allows show/hide the participants panel toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarDisplayLogo | ||||||
settoolbarDisplayLogo(value: string | boolean)
|
||||||
|
The toolbarDisplayLogo attribute allows show/hide the branding logo. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarDisplaySessionName | ||||||
settoolbarDisplaySessionName(value: string | boolean)
|
||||||
|
The toolbarDisplaySessionName attribute allows show/hide the session name. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| toolbarCaptionsButton | ||||||
settoolbarCaptionsButton(value: string | boolean)
|
||||||
|
The toolbarCaptionsButton attribute allows show/hide the captions toolbar button. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| streamDisplayParticipantName | ||||||
setstreamDisplayParticipantName(value: string | boolean)
|
||||||
|
The streamDisplayParticipantName attribute allows show/hide the participants name in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| streamDisplayAudioDetection | ||||||
setstreamDisplayAudioDetection(value: string | boolean)
|
||||||
|
The streamDisplayAudioDetection attribute allows show/hide the participants audio detection in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| streamSettingsButton | ||||||
setstreamSettingsButton(value: string | boolean)
|
||||||
|
The streamSettingsButton attribute allows show/hide the participants settings button in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| streamResolution | ||||||
setstreamResolution(value: string)
|
||||||
|
The resolution directive allows to set a specific participant resolution in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| streamFrameRate | ||||||
setstreamFrameRate(value: number)
|
||||||
|
The frameRate directive allows initialize the publisher with a specific frame rate in stream component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| participantPanelItemMuteButton | ||||||
setparticipantPanelItemMuteButton(value: string | boolean)
|
||||||
|
The participantPanelItemMuteButton attribute allows show/hide the muted button in participant panel item component. Default:
WARNING: If you want to use this parameter to OpenVidu Web Component statically, you have to replace the camelCase with a hyphen between words.
Parameters :
Example :
Returns :
void
|
| recordingActivityRecordingError | ||||||
setrecordingActivityRecordingError(value: any)
|
||||||
|
The recordingActivityRecordingError attribute allows to show any possible error with the recording in the RecordingActivityComponent. Default:
Parameters :
Example :
Returns :
void
|
| activitiesPanelRecordingActivity | ||||||
setactivitiesPanelRecordingActivity(value: string | boolean)
|
||||||
|
The activitiesPanelRecordingActivity attribute allows show/hide the recording activity in ActivitiesPanelComponent. Default:
Parameters :
Example :
Returns :
void
|
| activitiesPanelBroadcastingActivity | ||||||
setactivitiesPanelBroadcastingActivity(value: string | boolean)
|
||||||
|
The activitiesPanelBroadcastingActivity attribute allows show/hide the broadcasting activity in ActivitiesPanelComponent. Default:
Parameters :
Example :
Returns :
void
|
| broadcastingActivityBroadcastingError | ||||||
setbroadcastingActivityBroadcastingError(value: any)
|
||||||
|
The broadcastingActivityBroadcastingError attribute allows to show any possible error with the broadcasting in the BroadcastingActivityComponent. Default:
Parameters :
Example :
Returns :
void
|
| recordingActivityRecordingsList | ||||||
setrecordingActivityRecordingsList(value: RecordingInfo[])
|
||||||
|
The recordingActivityRecordingList attribute allows show to show the recordings available for the session in RecordingActivityComponent. Default:
Parameters :
Example :
Returns :
void
|
| tokens | ||||||
settokens(value: TokenModel | string)
|
||||||
|
Tokens parameter is required to grant a participant access to a Session. This OpenVidu token will be use by each participant when connecting to a Session. This input accepts a TokenModel object type or a string type.
Parameters :
Example :
Returns :
void
|