gstreamer-rs/docs/gstreamer-rtsp/docs.md
Sebastian Dröge d2467b4b65 Update docs
2020-07-06 15:22:07 +03:00

7.8 KiB

Authentication methods, ordered by strength

no authentication

basic authentication

digest authentication

RTSP Authentication parameter

Feature: v1_12

The possible events for the connection.

connection is readable

connection is writable

The possible network families.

unknown network family

internet

internet V6

Enumeration of rtsp header fields

The different transport methods.

invalid transport flag

stream data over UDP

stream data over UDP multicast

stream data over TCP

stream data tunneled over HTTP.

encrypt TCP and HTTP with TLS

The different supported RTSP methods.

invalid method

the DESCRIBE method

the ANNOUNCE method

the GET_PARAMETER method

the OPTIONS method

the PAUSE method

the PLAY method

the RECORD method

the REDIRECT method

the SETUP method

the SET_PARAMETER method

the TEARDOWN method

the GET method (HTTP).

the POST method (HTTP).

The type of a message.

invalid message type

RTSP request message

RTSP response message

HTTP request message.

HTTP response message.

data message

The transfer profile to use.

invalid profile

the Audio/Visual profile (RFC 3551)

the secure Audio/Visual profile (RFC 3711)

the Audio/Visual profile with feedback (RFC 4585)

the secure Audio/Visual profile with feedback (RFC 5124)

Different possible time range units.

SMPTE timecode

29.97 frames per second

25 frames per second

Normal play time

Absolute time expressed as ISO 8601 timestamps

Result codes from the RTSP functions.

no error

some unspecified error occurred

invalid arguments were provided to a function

an operation was canceled

no memory was available for the operation

a host resolve error occurred

function not implemented

a system error occurred, errno contains more details

a parsing error occurred

windows networking could not start

windows networking stack has wrong version

end-of-file was reached

a network problem occurred, h_errno contains more details

the host is not an IP host

a timeout occurred

the tunnel GET request has been performed

the tunnel POST request has been performed

last error

The different RTSP states.

invalid state

initializing

ready for operation

seeking in progress

playing

recording

Enumeration of rtsp status codes

Possible time types.

seconds

now

end

frames and subframes

UTC time

The transfer mode to use.

invalid tansport mode

transfer RTP data

transfer RDT (RealMedia) data

Provides helper functions to handle RTSP urls.

Make a copy of self.

Returns

a copy of self. Free with gst_rtsp_url_free () after usage.

Splits the path of self on '/' boundaries, decoding the resulting components,

The decoding performed by this routine is "URI decoding", as defined in RFC 3986, commonly known as percent-decoding. For example, a string "foo%2fbar" will decode to "foo/bar" -- the %2f being replaced by the corresponding byte with hex value 0x2f. Note that there is no guarantee that the resulting byte sequence is valid in any given encoding. As a special case, %00 is not unescaped to NUL, as that would prematurely terminate the string.

Also note that since paths usually start with a slash, the first component will usually be the empty string.

Returns

None-terminated array of URL components. Free with g_strfreev when no longer needed.

Free the memory used by self.

Get the port number of self.

port

location to hold the port

Returns

RTSPResult::Ok.

Get a newly allocated string describing the request URI for self.

Returns

a string with the request URI. g_free after usage.

Get a newly allocated string describing the request URI for self combined with the control path for control_path

Feature: v1_18

control_path

an RTSP aggregate control path

Returns

a string with the request URI combined with the control path. g_free after usage.

Set the port number in self to port.

port

the port

Returns

RTSPResult::Ok.

Parse the RTSP urlstr into a newly allocated RTSPUrl. Free after usage with RTSPUrl::free.

urlstr

the url string to parse

url

location to hold the result.

Returns

a RTSPResult.