GstRTSPMessage

GstRtsp.RTSPAuthCredential

Since : 1.12

GstRtsp.RTSPAuthParam

Since : 1.12

GstRtsp.RTSPAuthParam.prototype.copy

function GstRtsp.RTSPAuthParam.prototype.copy(): {
    // javascript wrapper for 'gst_rtsp_auth_param_copy'
}

GstRtsp.RTSPAuthParam.prototype.free

function GstRtsp.RTSPAuthParam.prototype.free(): {
    // javascript wrapper for 'gst_rtsp_auth_param_free'
}

GstRtsp.RTSPMessage

GstRtsp.RTSPMessage.prototype.add_header

function GstRtsp.RTSPMessage.prototype.add_header(field: GstRtsp.RTSPHeaderField, value: String): {
    // javascript wrapper for 'gst_rtsp_message_add_header'
}

Add a header with key field and value to msg. This function takes a copy of value.

GstRtsp.RTSPMessage.prototype.add_header_by_name

function GstRtsp.RTSPMessage.prototype.add_header_by_name(header: String, value: String): {
    // javascript wrapper for 'gst_rtsp_message_add_header_by_name'
}

Add a header with key header and value to msg. This function takes a copy of value.

Since : 1.6

GstRtsp.RTSPMessage.prototype.append_headers

function GstRtsp.RTSPMessage.prototype.append_headers(str: GString (not introspectable)): {
    // javascript wrapper for 'gst_rtsp_message_append_headers'
}

Append the currently configured headers in msg to the GString (not introspectable) str suitable for transmission.

GstRtsp.RTSPMessage.prototype.copy

function GstRtsp.RTSPMessage.prototype.copy(): {
    // javascript wrapper for 'gst_rtsp_message_copy'
}

Allocate a new copy of msg and store the result in copy. The value in copy should be release with gst_rtsp_message_free function.

Since : 1.14

GstRtsp.RTSPMessage.prototype.dump

function GstRtsp.RTSPMessage.prototype.dump(): {
    // javascript wrapper for 'gst_rtsp_message_dump'
}

Dump the contents of msg to stdout.

GstRtsp.RTSPMessage.prototype.free

function GstRtsp.RTSPMessage.prototype.free(): {
    // javascript wrapper for 'gst_rtsp_message_free'
}

Free the memory used by msg.

GstRtsp.RTSPMessage.prototype.get_body

function GstRtsp.RTSPMessage.prototype.get_body(): {
    // javascript wrapper for 'gst_rtsp_message_get_body'
}

Get the body of msg. data remains valid for as long as msg is valid and unchanged.

If the message body was set as a Gst.Buffer before this will cause the data to be copied and stored in the message. The Gst.Buffer will no longer be kept in the message.

GstRtsp.RTSPMessage.prototype.get_body_buffer

function GstRtsp.RTSPMessage.prototype.get_body_buffer(): {
    // javascript wrapper for 'gst_rtsp_message_get_body_buffer'
}

Get the body of msg. buffer remains valid for as long as msg is valid and unchanged.

If body data was set from raw memory instead of a Gst.Buffer this function will always return null. The caller can check if there is a body buffer by calling GstRtsp.RTSPMessage.prototype.has_body_buffer.

Since : 1.16

GstRtsp.RTSPMessage.prototype.get_header

function GstRtsp.RTSPMessage.prototype.get_header(field: GstRtsp.RTSPHeaderField, indx: Number): {
    // javascript wrapper for 'gst_rtsp_message_get_header'
}

Get the indx header value with key field from msg. The result in value stays valid as long as it remains present in msg.

GstRtsp.RTSPMessage.prototype.get_header_by_name

function GstRtsp.RTSPMessage.prototype.get_header_by_name(header: String, index: Number): {
    // javascript wrapper for 'gst_rtsp_message_get_header_by_name'
}

Get the index header value with key header from msg. The result in value stays valid as long as it remains present in msg.

Since : 1.6

GstRtsp.RTSPMessage.prototype.get_type

function GstRtsp.RTSPMessage.prototype.get_type(): {
    // javascript wrapper for 'gst_rtsp_message_get_type'
}

Get the message type of msg.

GstRtsp.RTSPMessage.prototype.has_body_buffer

function GstRtsp.RTSPMessage.prototype.has_body_buffer(): {
    // javascript wrapper for 'gst_rtsp_message_has_body_buffer'
}

Checks if msg has a body and the body is stored as Gst.Buffer.

Since : 1.16

GstRtsp.RTSPMessage.prototype.init

function GstRtsp.RTSPMessage.prototype.init(): {
    // javascript wrapper for 'gst_rtsp_message_init'
}

Initialize msg. This function is mostly used when msg is allocated on the stack. The reverse operation of this is GstRtsp.RTSPMessage.prototype.unset.

GstRtsp.RTSPMessage.prototype.init_data

function GstRtsp.RTSPMessage.prototype.init_data(channel: Number): {
    // javascript wrapper for 'gst_rtsp_message_init_data'
}

Initialize a new data GstRtsp.RTSPMessage for channel.

GstRtsp.RTSPMessage.prototype.init_request

function GstRtsp.RTSPMessage.prototype.init_request(method: GstRtsp.RTSPMethod, uri: String): {
    // javascript wrapper for 'gst_rtsp_message_init_request'
}

Initialize msg as a request message with method and uri. To clear msg again, use GstRtsp.RTSPMessage.prototype.unset.

GstRtsp.RTSPMessage.prototype.init_response

function GstRtsp.RTSPMessage.prototype.init_response(code: GstRtsp.RTSPStatusCode, reason: String, request: GstRtsp.RTSPMessage): {
    // javascript wrapper for 'gst_rtsp_message_init_response'
}

Initialize msg with code and reason.

When reason is null, the default reason for code will be used.

When request is not null, the relevant headers will be copied to the new response message.

GstRtsp.RTSPMessage.prototype.parse_auth_credentials

function GstRtsp.RTSPMessage.prototype.parse_auth_credentials(field: GstRtsp.RTSPHeaderField): {
    // javascript wrapper for 'gst_rtsp_message_parse_auth_credentials'
}

Parses the credentials given in a WWW-Authenticate or Authorization header.

Since : 1.12

GstRtsp.RTSPMessage.prototype.parse_data

function GstRtsp.RTSPMessage.prototype.parse_data(): {
    // javascript wrapper for 'gst_rtsp_message_parse_data'
}

Parse the data message msg and store the channel in channel.

GstRtsp.RTSPMessage.prototype.parse_request

function GstRtsp.RTSPMessage.prototype.parse_request(): {
    // javascript wrapper for 'gst_rtsp_message_parse_request'
}

Parse the request message msg and store the values method, uri and version. The result locations can be null if one is not interested in its value.

uri remains valid for as long as msg is valid and unchanged.

GstRtsp.RTSPMessage.prototype.parse_response

function GstRtsp.RTSPMessage.prototype.parse_response(): {
    // javascript wrapper for 'gst_rtsp_message_parse_response'
}

Parse the response message msg and store the values code, reason and version. The result locations can be null if one is not interested in its value.

reason remains valid for as long as msg is valid and unchanged.

GstRtsp.RTSPMessage.prototype.remove_header

function GstRtsp.RTSPMessage.prototype.remove_header(field: GstRtsp.RTSPHeaderField, indx: Number): {
    // javascript wrapper for 'gst_rtsp_message_remove_header'
}

Remove the indx header with key field from msg. If indx equals -1, all headers will be removed.

GstRtsp.RTSPMessage.prototype.remove_header_by_name

function GstRtsp.RTSPMessage.prototype.remove_header_by_name(header: String, index: Number): {
    // javascript wrapper for 'gst_rtsp_message_remove_header_by_name'
}

Remove the index header with key header from msg. If index equals -1, all matching headers will be removed.

Since : 1.6

GstRtsp.RTSPMessage.prototype.set_body

function GstRtsp.RTSPMessage.prototype.set_body(data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_rtsp_message_set_body'
}

Set the body of msg to a copy of data. Any existing body or body buffer will be replaced by the new body.

GstRtsp.RTSPMessage.prototype.set_body_buffer

function GstRtsp.RTSPMessage.prototype.set_body_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_rtsp_message_set_body_buffer'
}

Set the body of msg to buffer. Any existing body or body buffer will be replaced by the new body.

Since : 1.16

GstRtsp.RTSPMessage.prototype.steal_body

function GstRtsp.RTSPMessage.prototype.steal_body(): {
    // javascript wrapper for 'gst_rtsp_message_steal_body'
}

Take the body of msg and store it in data and size. After this method, the body and size of msg will be set to null and 0 respectively.

GstRtsp.RTSPMessage.prototype.steal_body_buffer

function GstRtsp.RTSPMessage.prototype.steal_body_buffer(): {
    // javascript wrapper for 'gst_rtsp_message_steal_body_buffer'
}

Take the body of msg and store it in buffer. After this method, the body and size of msg will be set to null and 0 respectively.

If body data was set from raw memory instead of a Gst.Buffer this function will always return null. The caller can check if there is a body buffer by calling GstRtsp.RTSPMessage.prototype.has_body_buffer.

Since : 1.16

GstRtsp.RTSPMessage.prototype.take_body

function GstRtsp.RTSPMessage.prototype.take_body(data: [ Number ], size: Number): {
    // javascript wrapper for 'gst_rtsp_message_take_body'
}

Set the body of msg to data and size. This method takes ownership of data. Any existing body or body buffer will be replaced by the new body.

GstRtsp.RTSPMessage.prototype.take_body_buffer

function GstRtsp.RTSPMessage.prototype.take_body_buffer(buffer: Gst.Buffer): {
    // javascript wrapper for 'gst_rtsp_message_take_body_buffer'
}

Set the body of msg to buffer. This method takes ownership of buffer. Any existing body or body buffer will be replaced by the new body.

Since : 1.16

GstRtsp.RTSPMessage.prototype.take_header

function GstRtsp.RTSPMessage.prototype.take_header(field: GstRtsp.RTSPHeaderField, value: String): {
    // javascript wrapper for 'gst_rtsp_message_take_header'
}

Add a header with key field and value to msg. This function takes ownership of value.

GstRtsp.RTSPMessage.prototype.take_header_by_name

function GstRtsp.RTSPMessage.prototype.take_header_by_name(header: String, value: String): {
    // javascript wrapper for 'gst_rtsp_message_take_header_by_name'
}

Add a header with key header and value to msg. This function takes ownership of value, but not of header.

Since : 1.6

GstRtsp.RTSPMessage.prototype.unset

function GstRtsp.RTSPMessage.prototype.unset(): {
    // javascript wrapper for 'gst_rtsp_message_unset'
}

Unset the contents of msg so that it becomes an uninitialized GstRtsp.RTSPMessage again. This function is mostly used in combination with GstRtsp.RTSPMessage.prototype.init_request, GstRtsp.RTSPMessage.prototype.init_response and GstRtsp.RTSPMessage.prototype.init_data on stack allocated GstRtsp.RTSPMessage structures.

GstRtsp.prototype.rtsp_auth_credentials_free

function GstRtsp.prototype.rtsp_auth_credentials_free(credentials: GstRtsp.RTSPAuthCredential): {
    // javascript wrapper for 'gst_rtsp_auth_credentials_free'
}

Free a null-terminated array of credentials returned from GstRtsp.RTSPMessage.prototype.parse_auth_credentials.

Since : 1.12

GstRtsp.prototype.rtsp_message_new

function GstRtsp.prototype.rtsp_message_new(): {
    // javascript wrapper for 'gst_rtsp_message_new'
}

Create a new initialized GstRtsp.RTSPMessage. Free with GstRtsp.RTSPMessage.prototype.free.

GstRtsp.prototype.rtsp_message_new_data

function GstRtsp.prototype.rtsp_message_new_data(channel: Number): {
    // javascript wrapper for 'gst_rtsp_message_new_data'
}

Create a new data GstRtsp.RTSPMessage with channel and store the result message in msg. Free with GstRtsp.RTSPMessage.prototype.free.

GstRtsp.prototype.rtsp_message_new_request

function GstRtsp.prototype.rtsp_message_new_request(method: GstRtsp.RTSPMethod, uri: String): {
    // javascript wrapper for 'gst_rtsp_message_new_request'
}

Create a new GstRtsp.RTSPMessage with method and uri and store the result request message in msg. Free with GstRtsp.RTSPMessage.prototype.free.

GstRtsp.prototype.rtsp_message_new_response

function GstRtsp.prototype.rtsp_message_new_response(code: GstRtsp.RTSPStatusCode, reason: String, request: GstRtsp.RTSPMessage): {
    // javascript wrapper for 'gst_rtsp_message_new_response'
}

Create a new response GstRtsp.RTSPMessage with code and reason and store the result message in msg. Free with GstRtsp.RTSPMessage.prototype.free.

When reason is null, the default reason for code will be used.

When request is not null, the relevant headers will be copied to the new response message.

GstRtsp.RTSPMsgType

The type of a message.