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 |
| activitiesPanelRecordingActivity |
Type : string | boolean
|
|
The activitiesPanelRecordingActivity attribute allows show/hide the recording activity in ActivitiesPanelComponent. Default: |
| 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: |
| 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. |
| onActivitiesPanelStartRecordingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when start recording button is clicked ActivitiesPanelComponent. The recording 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>
|
| 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
|
| onStartRecordingClicked | ||||||
onStartRecordingClicked(from: string)
|
||||||
|
Parameters :
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
|
| 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
|
| 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
|
| 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
|
| 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
|