org.kurento.room.api

Interface RoomHandler

All Known Subinterfaces:

NotificationRoomHandler

All Known Implementing Classes:

DefaultNotificationRoomHandler

public interface RoomHandler

Handler for events triggered from media objects.

Author:

Radu Tom Vlad

Method Summary

Modifier and Type	Method and Description
void	onIceCandidate(String roomName, String participantId, String endpoint, org.kurento.client.IceCandidate candidate) Called when a new IceCandidate is gathered for the local WebRTC endpoint.
void	onMediaElementError(String roomName, String participantId, String errorDescription) Called as a result of an error intercepted on a media element of a participant.
void	onPipelineError(String roomName, Set<String> participantIds, String errorDescription) Called as a result of an error intercepted on the media pipeline.

Method Detail

onIceCandidate

void onIceCandidate(String roomName,
                    String participantId,
                    String endpoint,
                    org.kurento.client.IceCandidate candidate)

Called when a new IceCandidate is gathered for the local WebRTC endpoint. The user should receive a notification with all the provided information so that the candidate is added to the remote WebRTC peer.

Parameters:

roomName - name of the room

participantId - identifier of the participant

endpoint - String the identifier of the local WebRTC endpoint (created in the server)

candidate - the gathered IceCandidate

onMediaElementError

void onMediaElementError(String roomName,
                         String participantId,
                         String errorDescription)

Called as a result of an error intercepted on a media element of a participant. The participant should be notified.

Parameters:

roomName - name of the room

participantId - identifier of the participant

description - description of the error

onPipelineError

void onPipelineError(String roomName,
                     Set<String> participantIds,
                     String errorDescription)

Called as a result of an error intercepted on the media pipeline. The affected participants should be notified.

Parameters:

roomName - the room where the error occurred

participantIds - the participants identifiers

description - description of the error