projects/openvidu-angular/src/lib/components/videoconference/videoconference.component.ts
The VideoconferenceComponent is the parent of all OpenVidu components. It allow us to create a modern, useful and powerful videoconference apps with ease.
This component allows us to show or hide certain HTML elements with the following Angular attribute directives with the aim of fully customizing the videoconference application.
| Parameter | Type | Reference |
|---|---|---|
| minimal | boolean |
MinimalDirective |
| lang | string |
LangDirective |
| langOptions | LangOption [] |
LangOptionsDirective |
| captionsLang | string |
CaptionsLangDirective |
| captionsLangOptions | CaptionsLangOption [] |
CaptionsLangOptionsDirective |
| prejoin | boolean |
PrejoinDirective |
| participantName | string |
ParticipantNameDirective |
| videoMuted | boolean |
VideoMutedDirective |
| audioMuted | boolean |
AudioMutedDirective |
| simulcast | boolean |
SimulcastDirective |
| toolbarScreenshareButton | boolean |
ToolbarScreenshareButtonDirective |
| toolbarFullscreenButton | boolean |
ToolbarFullscreenButtonDirective |
| toolbarCaptionsButton | boolean |
ToolbarCaptionsButtonDirective |
| toolbarBackgroundEffectsButton | boolean |
ToolbarBackgroundEffectsButtonDirective |
| toolbarLeaveButton | boolean |
ToolbarLeaveButtonDirective |
| toolbarChatPanelButton | boolean |
ToolbarChatPanelButtonDirective |
| toolbarParticipantsPanelButton | boolean |
ToolbarParticipantsPanelButtonDirective |
| toolbarDisplayLogo | boolean |
ToolbarDisplayLogoDirective |
| toolbarDisplaySessionName | boolean |
ToolbarDisplaySessionNameDirective |
| streamDisplayParticipantName | boolean |
StreamDisplayParticipantNameDirective |
| streamDisplayAudioDetection | boolean |
StreamDisplayAudioDetectionDirective |
| streamSettingsButton | boolean |
StreamSettingsButtonDirective |
| streamFrameRate | number |
StreamFrameRateDirective |
| streamResolution | string |
StreamResolutionDirective |
| participantPanelItemMuteButton | boolean |
ParticipantPanelItemMuteButtonDirective |
| recordingActivityRecordingList | RecordingInfo[] |
RecordingActivityRecordingsListDirective |
| recordingActivityRecordingError | any |
RecordingActivityRecordingErrorDirective |
See all API Directives
The VideoconferenceComponent is also providing us a way to replace the default templates with a custom one. It will recognise the following Angular structural directives in the elements added as children.
| Directive | Reference |
|---|---|
| *ovToolbar | ToolbarDirective |
| *ovToolbarAdditionalButtons | ToolbarAdditionalButtonsDirective |
| *ovToolbarAdditionalPanelButtons | ToolbarAdditionalPanelButtonsDirective |
| *ovPanel | PanelDirective |
| *ovAdditionalPanels | AdditionalPanelsDirective |
| *ovChatPanel | ChatPanelDirective |
| *ovParticipantsPanel | ParticipantsPanelDirective |
| *ovParticipantPanelItem | ParticipantPanelItemDirective |
| *ovParticipantPanelItemElements | ParticipantPanelItemElementsDirective |
| *ovLayout | LayoutDirective |
| *ovStream | StreamDirective |
See all OpenVidu Angular Directives
OnInit
OnDestroy
AfterViewInit
| selector | ov-videoconference |
| styleUrls | ./videoconference.component.css |
| templateUrl | ./videoconference.component.html |
| tokens |
Type : TokenModel
|
|
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. |
| 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. |
| onActivitiesPanelForceRecordingUpdate |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when a participant needs update the recordings information (usually when recording is stopped by the session moderator or recording panel is opened) from ActivitiesPanelComponent. The recordings should be updated using the REST API. |
| onActivitiesPanelPlayRecordingClicked |
Type : EventEmitter<string>
|
|
Provides event notifications that fire when play recording button is clicked from ActivitiesPanelComponent. |
| onActivitiesPanelStartBroadcastingClicked |
Type : EventEmitter<string>
|
|
Provides event notifications that fire when start broadcasting button is clicked from ActivitiesPanelComponent. |
| 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. |
| onActivitiesPanelStopBroadcastingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when start broadcasting button is clicked from ActivitiesPanelComponent. |
| 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. |
| onLangChanged |
Type : EventEmitter<LangOption>
|
|
Provides event notifications that fire when the application language has changed. |
| onNodeCrashed |
Type : EventEmitter<void>
|
|
Provides event notifications that fire in the case of a node crash in your OpenVidu deployment. OpenVidu delegates the recovery of the sessions to the application in the event of a node crash. See OpenVidu Pro Fault tolerance. |
| 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 ToolbarComponent. The recording should be stopped using the REST API. |
| onToolbarStopBroadcastingClicked |
Type : EventEmitter<void>
|
|
Provides event notifications that fire when start broadcasting button is clicked from ToolbarComponent. |
| 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. |
| tokens | ||||||||
settokens(tokens: TokenModel)
|
||||||||
|
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.
Parameters :
Returns :
void
|