whipsink

whipsink is an element that acts a WHIP Client to ingest RTP content to a media server

gst-launch-1.0 videotestsrc ! videoconvert ! openh264enc ! rtph264pay ! \
'application/x-rtp,media=video,encoding-name=H264,payload=97,clock-rate=90000' ! \
whip.sink_0 audiotestsrc ! audioconvert ! opusenc ! rtpopuspay ! \
'application/x-rtp,media=audio,encoding-name=OPUS,payload=96,clock-rate=48000,encoding-params=(string)2' ! \
whip.sink_1 whipsink name=whip auth-token=$WHIP_TOKEN whip-endpoint=$WHIP_ENDPOINT

Note: whipsink will be deprecated in the future. It is replaced by whipclientsink, which provides more features such as managing encoding and performing bandwidth adaptation

Hierarchy

GObject
    ╰──GInitiallyUnowned
        ╰──GstObject
            ╰──GstElement
                ╰──GstBin
                    ╰──whipsink

Implemented interfaces

GstChildProxy

Factory details

Authors: – Taruntej Kanakamalla

Classification: – Sink/Network/WebRTC

Rank – marginal

Plugin – webrtchttp

Package – gst-plugin-webrtchttp

Pad Templates

`sink_%u`

application/x-rtp:

Presence – request

Direction – sink

Object type – GstPad

Properties

auth-token

“auth-token” gchararray

Authentication token to use, will be sent in the HTTP Header as 'Bearer '

Flags : Read / Write

Default value : NULL

ice-transport-policy

“ice-transport-policy” GstRsWebRTCICETransportPolicy *

The policy to apply for ICE transport

Flags : Read / Write

Default value : all (0)

stun-server

“stun-server” gchararray

The STUN server of the form stun://hostname:port

Flags : Read / Write

Default value : NULL

timeout

“timeout” guint

Value in seconds to timeout WHIP endpoint requests (0 = No timeout).

Flags : Read / Write

Default value : 15

turn-server

“turn-server” gchararray

The TURN server of the form turn(s)://username:password@host:port.

Flags : Read / Write

Default value : NULL

use-link-headers

“use-link-headers” gboolean

Use link headers to configure ice-servers from the WHIP server response to the POST request. If set to TRUE and the WHIP server returns valid ice-servers, this property overrides the ice-servers values set using the stun-server and turn-server properties.

Flags : Read / Write

Default value : false

whip-endpoint

“whip-endpoint” gchararray

The WHIP server endpoint to POST SDP offer to. e.g.: https://example.com/whip/endpoint/room1234

Flags : Read / Write

Default value : NULL

Named constants

GstRsWebRTCICETransportPolicy

Members

all (0) – All: get both STUN and TURN candidate pairs

relay (1) – Relay: get only TURN candidate pairs

The results of the search are