OpenVidu Angular Documentation
  1. Injectables
  2. OpenViduService

File

projects/openvidu-angular/src/lib/services/openvidu/openvidu.service.ts

Index

Properties
Methods

Methods

disconnect
disconnect()

Leaves the session, destroying all local streams and clean all participant data.

Returns : void
getRemoteConnections
getRemoteConnections()

Returns the remote connections of the Session. See Connection object.

Returns : Connection[]
getSession
getSession()

Returns the local Session. See Session object.

Returns : Session
isSessionConnected
isSessionConnected()
Returns : boolean
publishAudio
This method has been moved to ParticipantService TODO: Remove this method in release 2.29.0
publishAudio(publish: boolean)

Publish or unpublish the audio stream (if available). See openvidu-browser publishAudio.

TODO: Remove this method in release 2.29.0

Parameters :
Name Type Optional
publish boolean No
Returns : void
Async publishCamera
publishCamera(publisher: Publisher)

Publishes the publisher to the webcam Session

Parameters :
Name Type Optional
publisher Publisher No
Returns : Promise<void>
Async publishScreen
publishScreen(publisher: Publisher)

Publishes the publisher to the screen Session

Parameters :
Name Type Optional
publisher Publisher No
Returns : Promise<void>
Async publishVideo
This method has been moved to ParticipantService TODO: Remove this method in release 2.29.0
publishVideo(publish: boolean)

Publish or unpublish the video stream (if available). It hides the camera muted stream if screen is sharing. See openvidu-browser publishVideo

TODO: Remove this method in release 2.29.0

Parameters :
Name Type Optional
publish boolean No
Returns : Promise<void>
Async toggleScreenshare
This method has been moved to ParticipantService TODO: Remove this method in release 2.29.0
toggleScreenshare()

Share or unshare the screen. Hide the camera muted stream when screen is sharing.

TODO: Remove this method in release 2.29.0

Returns : unknown
Async unpublishCamera
unpublishCamera(publisher: Publisher)

Unpublishes the publisher of the webcam Session

Parameters :
Name Type Optional
publisher Publisher No
Returns : Promise<void>
Async unpublishScreen
unpublishScreen(publisher: Publisher)

Unpublishes the publisher of the screen Session

Parameters :
Name Type Optional
publisher Publisher No
Returns : Promise<void>
Async updateVideoEncodingParameters
updateVideoEncodingParameters(streamManager: StreamManager)
Parameters :
Name Type Optional
streamManager StreamManager No
Returns : any

Properties

isSttReadyObs
Type : Observable<boolean>

results matching ""

    No results matching ""