/home/carlos/CODEURJC/openvidu/openvidu-components-angular/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 |
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:
|
tokens |
Type : TokenModel | string
|
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. |
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. |
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
tokens | ||||||
settokens(value: TokenModel | string)
|
||||||
Parameters :
Example :
Returns :
void
|