projects/openvidu-components-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.
OnInit
OnDestroy
AfterViewInit
selector | ov-videoconference |
styleUrls | ./videoconference.component.scss |
templateUrl | ./videoconference.component.html |
onActivitiesPanelStatusChanged |
Type : EventEmitter<ActivitiesPanelStatusEvent>
|
This event is fired when the activities panel status has been changed. It provides the new status of the activities panel as ActivitiesPanelStatusEvent payload. |
onAudioDeviceChanged |
Type : EventEmitter<CustomDevice>
|
This event is emitted when the selected audio device changes, providing information about the new custom device that has been selected. |
onAudioEnabledChanged |
Type : EventEmitter<boolean>
|
This event is emitted when the audio state changes, providing information about if the audio is enabled (true) or disabled (false). |
onBroadcastingStartRequested |
Type : EventEmitter<BroadcastingStartRequestedEvent>
|
Provides event notifications that fire when start broadcasting button is clicked. It provides the BroadcastingStartRequestedEvent payload as event data. |
onBroadcastingStopRequested |
Type : EventEmitter<BroadcastingStopRequestedEvent>
|
Provides event notifications that fire when stop broadcasting button is clicked. It provides the BroadcastingStopRequestedEvent payload as event data. |
onChatPanelStatusChanged |
Type : EventEmitter<ChatPanelStatusEvent>
|
This event is fired when the chat panel status has been changed. It provides the new status of the chat panel as ChatPanelStatusEvent payload. |
onFullscreenEnabledChanged |
Type : EventEmitter<boolean>
|
The event is emitted when the fullscreen state changes, providing information about if the fullscreen is enabled (true) or disabled (false). |
onLangChanged |
Type : EventEmitter<LangOption>
|
This event is emitted when the language changes, providing information about the new language that has been selected. |
onParticipantCreated |
Type : EventEmitter<ParticipantModel>
|
Provides event notifications that fire when local participant is created. It provides the ParticipantModel payload as event data. |
onParticipantsPanelStatusChanged |
Type : EventEmitter<ParticipantsPanelStatusEvent>
|
This event is fired when the participants panel status has been changed. It provides the new status of the participants panel as ParticipantsPanelStatusEvent payload. |
onReadyToJoin |
Type : EventEmitter<void>
|
Provides event notifications that fire when the participant is ready to join to the room. This event is only emitted when the prejoin page has been shown. |
onRecordingDeleteRequested |
Type : EventEmitter<RecordingDeleteRequestedEvent>
|
Provides event notifications that fire when delete recording button has been clicked. It provides the RecordingDeleteRequestedEvent payload as event data. |
onRecordingDownloadClicked |
Type : EventEmitter<RecordingDownloadClickedEvent>
|
Provides event notifications that fire when download recording button is clicked from ActivitiesPanelComponent. It provides the RecordingDownloadClickedEvent payload as event data. |
onRecordingPlayClicked |
Type : EventEmitter<RecordingPlayClickedEvent>
|
Provides event notifications that fire when play recording button is clicked from ActivitiesPanelComponent. It provides the RecordingPlayClickedEvent payload as event data. |
onRecordingStartRequested |
Type : EventEmitter<RecordingStartRequestedEvent>
|
This event is fired when the user clicks on the start recording button. It provides the RecordingStartRequestedEvent payload as event data. |
onRecordingStopRequested |
Type : EventEmitter<RecordingStopRequestedEvent>
|
Provides event notifications that fire when stop recording button has been clicked. It provides the RecordingStopRequestedEvent payload as event data. |
onRoomCreated |
Type : EventEmitter<Room>
|
Provides event notifications that fire when OpenVidu Room is created. It provides the Room payload as event data. |
onRoomDisconnected |
Type : EventEmitter<void>
|
Provides event notifications that fire when the room has been disconnected. |
onSettingsPanelStatusChanged |
Type : EventEmitter<SettingsPanelStatusEvent>
|
This event is fired when the settings panel status has been changed. It provides the new status of the settings panel as SettingsPanelStatusEvent payload. |
onTokenRequested |
Type : EventEmitter<string>
|
Provides event notifications that fire when videconference is ready to received the token. This event emits the participant name as data. |
onVideoDeviceChanged |
Type : EventEmitter<CustomDevice>
|
This event is emitted when the selected video device changes, providing information about the new custom device that has been selected. |
onVideoEnabledChanged |
Type : EventEmitter<boolean>
|
This event is emitted when the video state changes, providing information about if the video is enabled (true) or disabled (false). |
The VideoconferenceComponent also offers the option to tailor the default templates to your preferences using a custom template.
Directive | Reference |
---|---|
*ovToolbar | ToolbarDirective |
*ovToolbarAdditionalButtons | ToolbarAdditionalButtonsDirective |
*ovToolbarAdditionalPanelButtons | ToolbarAdditionalPanelButtonsDirective |
*ovPanel | PanelDirective |
*ovAdditionalPanels | AdditionalPanelsDirective |
*ovChatPanel | ChatPanelDirective |
*ovParticipantsPanel | ParticipantsPanelDirective |
*ovParticipantPanelItem | ParticipantPanelItemDirective |
*ovParticipantPanelItemElements | ParticipantPanelItemElementsDirective |
*ovLayout | LayoutDirective |
*ovStream | StreamDirective |
With the following directives you can modify the default User Interface with the aim of fully customizing your videoconference application.
Parameter | Type | Reference |
---|---|---|
livekitUrl | string |
LivekitUrlDirective |
token | string |
TokenDirective |
tokenError | any |
TokenErrorDirective |
minimal | boolean |
MinimalDirective |
lang | string |
LangDirective |
langOptions | LangOption |
LangOptionsDirective |
participantName | string |
ParticipantNameDirective |
prejoin | boolean |
PrejoinDirective |
videoEnabled | boolean |
VideoEnabledDirective |
audioEnabled | boolean |
AudioEnabledDirective |
toolbarScreenshareButton | boolean |
ToolbarScreenshareButtonDirective |
toolbarRecordingButton | boolean |
ToolbarRecordingButtonDirective |
toolbarBroadcastingButton | boolean |
ToolbarBroadcastingButtonDirective |
toolbarFullscreenButton | boolean |
ToolbarFullscreenButtonDirective |
toolbarBackgroundEffectsButton | boolean |
ToolbarBackgroundEffectsButtonDirective |
toolbarSettingsButton | boolean |
ToolbarSettingsButtonDirective |
toolbarLeaveButton | boolean |
ToolbarLeaveButtonDirective |
toolbarParticipantsPanelButton | boolean |
ToolbarParticipantsPanelButtonDirective |
toolbarChatPanelButton | boolean |
ToolbarChatPanelButtonDirective |
toolbarActivitiesPanelButton | boolean |
ToolbarActivitiesPanelButtonDirective |
toolbarDisplayRoomName | boolean |
ToolbarDisplayRoomNameDirective |
toolbarDisplayLogo | boolean |
ToolbarDisplayLogoDirective |
streamDisplayParticipantName | boolean |
StreamDisplayParticipantNameDirective |
streamDisplayAudioDetection | boolean |
StreamDisplayAudioDetectionDirective |
streamVideoControls | boolean |
StreamVideoControlsDirective |
participantPanelItemMuteButton | boolean |
ParticipantPanelItemMuteButtonDirective |
activitiesPanelRecordingActivity | boolean |
ActivitiesPanelRecordingActivityDirective |
activitiesPanelBroadcastingActivity | boolean |
ActivitiesPanelBroadcastingActivityDirective |