File

projects/openvidu-angular/src/lib/components/videoconference/videoconference.component.ts

Description

The VideoconferenceComponent is the parent of all OpenVidu components. It allow us to create a modern, useful and powerful videoconference apps with ease.

API Directives

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
captionsLang string CaptionsLangDirective
prejoin boolean PrejoinDirective
participantName string ParticipantNameDirective
videoMuted boolean VideoMutedDirective
audioMuted boolean AudioMutedDirective
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
participantPanelItemMuteButton boolean ParticipantPanelItemMuteButtonDirective
recordingActivityRecordingList RecordingInfo[] RecordingActivityRecordingsListDirective
recordingActivityRecordingError any RecordingActivityRecordingErrorDirective

OpenVidu Angular 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

Implements

OnInit OnDestroy AfterViewInit

Metadata

Index

Inputs
Outputs
Accessors

Inputs

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.

Outputs

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.

onActivitiesPanelPlayRecordingClicked
Type : EventEmitter<string>

Provides event notifications that fire when play recording 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.

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.

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.

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.

Accessors

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 :
Name Type Optional Description
tokens TokenModel No

The tokens parameter must be a TokenModel object.

Returns : void

results matching ""

    No results matching ""