GstRtspServer.RTSPToken¶

Fields¶

Name	Type	Access	Description
mini_object	`Gst.MiniObject`	r/w

Methods¶

class	`new` ()
	`get_string` (field)
	`get_structure` ()
	`is_allowed` (field)
	`set_bool` (field, bool_value)
	`set_string` (field, string_value)
	`writable_structure` ()

Details¶

class GstRtspServer.RTSPToken¶

An opaque object used for checking authorisations. It is generated after successful authentication.

classmethod new()[source]¶

Returns:: a new empty authorization token.
Return type:: GstRtspServer.RTSPToken

Create a new empty Authorization token.

get_string(field)[source]¶

Parameters:: field (str) – a field name
Returns:: the string value of field in self or None when field is not defined in self. The string becomes invalid when you free self.
Return type:: str or None

Get the string value of field in self.

get_structure()[source]¶

Returns:

The structure of the token. The structure is still owned by the token, which means that you should not free it and that the pointer becomes invalid when you free the token.

MT safe.

Return type:

Gst.Structure

Access the structure of the token.

is_allowed(field)[source]¶

Parameters:: field (str) – a field name
Returns:: True if self has a boolean field named field set to True.
Return type:: bool

Check if self has a boolean field and if it is set to True.

set_bool(field, bool_value)[source]¶

Parameters:

field (str) – field to set
bool_value (bool) – boolean value to set

Sets a boolean value on self.

New in version 1.14.

set_string(field, string_value)[source]¶

Parameters:

field (str) – field to set
string_value (str) – string value to set

Sets a string value on self.

New in version 1.14.

writable_structure()[source]¶

Returns:

The structure of the token. The structure is still owned by the token, which means that you should not free it and that the pointer becomes invalid when you free the token. This function ensures that self is writable, and if so, will never return None.

MT safe.

Return type:

Gst.Structure

Get a writable version of the structure.