GStreamer GstWebRTCSessionDescription

https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c
Admin
This documentation describes GstWebRTCSessionDescription, a structure within GStreamer's WebRTC...
Tokens:1,196
Snippets:10
Trust Score:7.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Create GstWebRTCSessionDescription (C)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Constructs a new GstWebRTCSessionDescription object in C. It takes a GstWebRTCSDPType and a GstSDPMessage, transferring ownership of the SDP message to the new description.

```C
GstWebRTCSessionDescription *
gst_webrtc_session_description_new (GstWebRTCSDPType type,
                                    GstSDPMessage * sdp)
  Parameters:
    type: GstWebRTCSDPType - a GstWebRTCSDPType
    sdp: GstSDPMessage (transfer: full) - a GstSDPMessage
  Returns (transfer: full): GstWebRTCSessionDescription - a new GstWebRTCSessionDescription from type and sdp
```

--------------------------------

### GStreamer WebRTC Library API Reference

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/index

Comprehensive API documentation for the GStreamer WebRTC library, including an overview of its components and their functionalities. Note that this API is currently considered unstable.

```APIDOC
WebRTC Library:
  Purpose: Provides WebRTC functionality for GStreamer applications.
  Linking: Link with cflags and libs from gstreamer-webrtc-1.0.
  Stability: API is considered unstable.
```

```APIDOC
GstWebRTC Enumerations:
  Description: Defines enumerations used within the WebRTC library.
```

```APIDOC
GstWebRTCDataChannel:
  Type: Object
  Description: Represents an RTCDataChannel object.
```

```APIDOC
GstWebRTCDTLSTransport:
  Type: Object
  Description: Represents an RTCDtlsTransport object.
```

```APIDOC
GstWebRTCICE:
  Type: Class
  Description: Base class for WebRTC ICE handling.
```

```APIDOC
GstWebRTCICEStream:
  Type: Object
  Description: Represents a GstWebRTCICEStream object.
```

```APIDOC
GstWebRTCICETransport:
  Type: Object
  Description: Represents an RTCIceTransport object.
```

```APIDOC
GstWebRTCRTPReceiver:
  Type: Object
  Description: Represents an RTCRtpReceiver object.
```

```APIDOC
GstWebRTCRTPSender:
  Type: Object
  Description: Represents an RTCRtpSender object.
```

```APIDOC
GstWebRTCRTPTransceiver:
  Type: Object
  Description: Represents an RTCRtpTransceiver object.
```

```APIDOC
GstWebRTCSessionDescription:
  Type: Object
  Description: Represents an RTCSessionDescription object.
```

```APIDOC
webrtc:
  Description: General WebRTC related functionality.
```

--------------------------------

### Create GstWebRTC.WebRTCSessionDescription (JavaScript)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Constructs a new GstWebRTC.WebRTCSessionDescription object using its JavaScript prototype. This is a wrapper for the underlying C function, taking a GstWebRTC.WebRTCSDPType and a GstSdp.SDPMessage.

```JavaScript
function GstWebRTC.WebRTCSessionDescription.prototype.new(type: GstWebRTC.WebRTCSDPType, sdp: GstSdp.SDPMessage): {
    // javascript wrapper for 'gst_webrtc_session_description_new'
}
  Parameters:
    type: GstWebRTC.WebRTCSDPType - a GstWebRTC.WebRTCSDPType
    sdp: GstSdp.SDPMessage - a GstSdp.SDPMessage
  Returns: GstWebRTC.WebRTCSessionDescription - a new GstWebRTC.WebRTCSessionDescription from type and sdp
```

--------------------------------

### Create GstWebRTC.WebRTCSessionDescription (Python)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Constructs a new GstWebRTC.WebRTCSessionDescription object in Python. This is a wrapper for the underlying C function, taking a GstWebRTC.WebRTCSDPType and a GstSdp.SDPMessage.

```Python
def GstWebRTC.WebRTCSessionDescription.new (type, sdp):
    #python wrapper for 'gst_webrtc_session_description_new'
  Parameters:
    type: GstWebRTC.WebRTCSDPType - a GstWebRTC.WebRTCSDPType
    sdp: GstSdp.SDPMessage - a GstSdp.SDPMessage
  Returns: GstWebRTC.WebRTCSessionDescription - a new GstWebRTC.WebRTCSessionDescription from type and sdp
```

--------------------------------

### Copy GstWebRTCSessionDescription (C)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Creates a new, full copy of an existing GstWebRTCSessionDescription object in C. The ownership of the new copy is transferred to the caller.

```C
GstWebRTCSessionDescription *
gst_webrtc_session_description_copy (const GstWebRTCSessionDescription * src)
  Parameters:
    src (transfer: none): GstWebRTCSessionDescription - a GstWebRTCSessionDescription
  Returns (transfer: full): GstWebRTCSessionDescription - a new copy of src
```

--------------------------------

### Copy GstWebRTC.WebRTCSessionDescription Object

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

This function creates a new copy of a GstWebRTC.WebRTCSessionDescription object. It is available as a method on the object prototype in JavaScript and as a class method in Python, wrapping the underlying C function.

```javascript
function GstWebRTC.WebRTCSessionDescription.prototype.copy(): {
    // javascript wrapper for 'gst_webrtc_session_description_copy'
}
```

```python
def GstWebRTC.WebRTCSessionDescription.copy (self):
    #python wrapper for 'gst_webrtc_session_description_copy'
```

```APIDOC
GstWebRTC.WebRTCSessionDescription.copy
  Description: Creates a new copy of a GstWebRTC.WebRTCSessionDescription object.
  Parameters:
    src: GstWebRTC.WebRTCSessionDescription - The source session description to copy.
  Returns:
    GstWebRTC.WebRTCSessionDescription - A new copy of src.
```

--------------------------------

### Free GstWebRTC.WebRTCSessionDescription Object

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

This function frees a GstWebRTC.WebRTCSessionDescription object and all associated resources. It is available as a direct C function, and as methods on the object prototype in JavaScript and as a class method in Python, wrapping the underlying C function.

```c
gst_webrtc_session_description_free (GstWebRTCSessionDescription * desc)
```

```javascript
function GstWebRTC.WebRTCSessionDescription.prototype.free(): {
    // javascript wrapper for 'gst_webrtc_session_description_free'
}
```

```python
def GstWebRTC.WebRTCSessionDescription.free (self):
    #python wrapper for 'gst_webrtc_session_description_free'
```

```APIDOC
GstWebRTC.WebRTCSessionDescription.free
  Description: Frees a GstWebRTC.WebRTCSessionDescription object and all associated resources.
  Parameters:
    desc: GstWebRTC.WebRTCSessionDescription (transfer: full) - The session description to free.
```

--------------------------------

### GstWebRTCSessionDescription Structure Definition (C)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Defines the GstWebRTCSessionDescription structure in C, which holds the type and SDP message for a WebRTC session description. It corresponds to the RTCSessionDescription class in the W3C WebRTC specification.

```APIDOC
GstWebRTCSessionDescription
  Members:
    type: GstWebRTCSDPType - the GstWebRTCSDPType of the description
    sdp: GstSDPMessage * - the GstSDPMessage of the description
```

--------------------------------

### GstWebRTC.WebRTCSessionDescription Class Definition (GObject)

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

Defines the GstWebRTC.WebRTCSessionDescription class, which holds the type and SDP message for a WebRTC session description. This is the GObject introspection equivalent, accessible from languages like JavaScript and Python, and corresponds to the RTCSessionDescription class in the W3C WebRTC specification.

```APIDOC
GstWebRTC.WebRTCSessionDescription
  Members:
    type: GstWebRTC.WebRTCSDPType - the GstWebRTC.WebRTCSDPType of the description
    sdp: GstSdp.SDPMessage - the GstSdp.SDPMessage of the description
```

--------------------------------

### Convert GstWebRTCSDPType to String

Source: https://gstreamer.freedesktop.org/documentation/webrtclib/gstwebrtc-sessiondescription.html?gi-language=c/gstwebrtc-sessiondescription

This function converts a GstWebRTCSDPType enumeration value into its string representation. It is available as a direct C function, and as methods on the object prototype in JavaScript and as a class method in Python, wrapping the underlying C function.

```c
const gchar *
gst_webrtc_sdp_type_to_string (GstWebRTCSDPType type)
```

```javascript
function GstWebRTC.WebRTCSDPType.prototype.to_string(type: GstWebRTC.WebRTCSDPType): {
    // javascript wrapper for 'gst_webrtc_sdp_type_to_string'
}
```

```python
def GstWebRTC.WebRTCSDPType.to_string (type):
    #python wrapper for 'gst_webrtc_sdp_type_to_string'
```

```APIDOC
GstWebRTC.WebRTCSDPType.to_string
  Description: Converts a GstWebRTCSDPType enumeration value to its string representation.
  Parameters:
    type: GstWebRTCSDPType - The SDP type enumeration value.
  Returns:
    string - The string representation of type or "unknown" if not recognized.
```
Tokens:
Raw