GstWebRTC - Predefined Signaling

← Signaler

⌂ Home

→ Custom Signalers

---

This page gives an overview of the available predefined signalers available in GstRrWebRTC.

Predefined Signalers

GstRrWebRTC plugin elements use the property signaler to indicate the predefined signaler to be used. Currently only OpenWebRTC signaler is supported, more predefined signalers are going to be supported as the project grows.

OpenWebRTC

OpenWebRTC signaler has three properties: session-id, server-url and api-token. In order to access the signaler properties, the signaler::<property> notation is used.

signaler::session-id

The session identifier, this ID has to be unique for each session. Default value: "ridgerun"

signaler::server-url

The URL of the signaler server. Ridgerun has it's own server running the OpenWebRTC signaler and web application in https://webrtc.ridgerun.com:8443/, this server can be used for testing GstRrWebRTC. Default value: "http://localhost:8080"

signaler::api-token

The API token identifier. This is used for assigning identifiers to the HTTP requests. Default value: "RRGstWebRTC"

PubNub

PubNub signaler has five properties: publish-key, subscribe-key, user-channel, peer-channel and origin-url. In order to access the signaler properties, the signaler::<property> notation is used.

signaler::publish-key

Key to Publish Messages (only set in NULL state). Default: "pub-c-561a7378-fa06-4c50-a331-5c0056d0163c"

signaler::subscribe-key

Key to Subscribe Messages (only set in NULL state). Default: "pubsub.pubnub.com"

signaler::user-channel

Username Channel (only set in NULL state). Default: "gstwebrtc"

signaler::peer-channel

Only Incoming Messages from this peer number will be accepted if set, If it is not set, incoming messages from any peer will be accepted. If start call is true, the offer SDP will be sent to this peer number, so that it is required. (only set in NULL state). Default: "(null)"

signaler::origin-url

PubNub Signaler Origin URL (only set in NULL state). Default: "pubsub.pubnub.com"

AppRTC

AppRTC signaler has two properties: session-id and server-url. In order to access the signaler properties, the signaler::<property> notation is used.

signaler::session-id

The session identifier, this ID has to be unique for each session. Default value: "ridgerun"

signaler::server-url

The URL of the signaler server. Ridgerun has it's own server running the AppRTC signaler and web application in https://webrtc.ridgerun.com:6443/, this server can be used for testing GstRrWebRTC. Default value: "http://localhost:8080"

GstOwrSignaler:

GstPubnubSignaler:

• publish-key: Key to Publish Messages (only set in NULL state). Default: "pub-c-561a7378-fa06-4c50-a331-5c0056d0163c"
• subscribe-key: Key to Subscribe Messages (only set in NULL state). Default: "pubsub.pubnub.com"
• user-channel: Username Channel (only set in NULL state). Default: "gstwebrtc"
• peer-channel: Only Incoming Messages from this peer number will be accepted if set, If it is not set, incoming messages from any peer will be accepted. If start call is true, the offer SDP will be sent to this peer number, so that it is required. (only set in NULL state). Default: "(null)"
• origin-url: PubNub Signaler Origin URL (only set in NULL state). Default: "pubsub.pubnub.com"

GstApprtcSignaler:

• session-id: Session Identification. Default: "ridgerun"
• server-url: URL Server Connection. Default: "http://localhost:8080"

Enum "GstWebRtcSignalers" Default: 1, "GstPubnubSignaler"
(0): GstOwrSignaler - Open WebRTC signaler
(1): GstPubnubSignaler - Pubnub signaler
(2): GstApprtcSignaler - AppRTC signaler

---

← Signaler

⌂ Home

→ Custom Signalers