Callbacks¶

	`RTSPClientSendFunc` (client, message, close, *user_data)
	`RTSPClientSendMessagesFunc` (client, messages, n_messages, close, *user_data)
	`RTSPClientSessionFilterFunc` (client, sess, *user_data)
	`RTSPKeepAliveFunc` (*user_data)
	`RTSPMessageSentFunc` (*user_data)
	`RTSPMessageSentFuncFull` (trans, *user_data)
	`RTSPSendFunc` (buffer, channel, *user_data)
	`RTSPSendListFunc` (buffer_list, channel, *user_data)
	`RTSPServerClientFilterFunc` (server, client, *user_data)
	`RTSPSessionFilterFunc` (sess, media, *user_data)
	`RTSPSessionPoolFilterFunc` (pool, session, *user_data)
	`RTSPSessionPoolFunc` (pool, *user_data)
	`RTSPStreamTransportFilterFunc` (stream, trans, *user_data)

Details¶

GstRtspServer.RTSPClientSendFunc(client, message, close, *user_data)¶

Parameters:	client (`GstRtspServer.RTSPClient`) – a `GstRtspServer.RTSPClient` message (`GstRtsp.RTSPMessage`) – a `GstRtsp.RTSPMessage` close (`bool`) – close the connection user_data (`object` or `None`) – user `GstRtsp.data` when registering the callback
Returns:	`True` on success.
Return type:	`bool`

This callback is called when client wants to send message. When close is True, the connection should be closed when the message has been sent.

GstRtspServer.RTSPClientSendMessagesFunc(client, messages, n_messages, close, *user_data)¶

Parameters:	client (`GstRtspServer.RTSPClient`) – a `GstRtspServer.RTSPClient` messages (`GstRtsp.RTSPMessage`) – `GstRtsp.RTSPMessage` n_messages (`int`) – number of messages close (`bool`) – close the connection user_data (`object` or `None`) – user `GstRtsp.data` when registering the callback
Returns:	`True` on success.
Return type:	`bool`

This callback is called when client wants to send messages. When close is True, the connection should be closed when the message has been sent.

New in version 1.16.

GstRtspServer.RTSPClientSessionFilterFunc(client, sess, *user_data)¶

Parameters:	client (`GstRtspServer.RTSPClient`) – a `GstRtspServer.RTSPClient` object sess (`GstRtspServer.RTSPSession`) – a `GstRtspServer.RTSPSession` in client user_data (`object` or `None`) – user `GstRtsp.data` that has been given to `GstRtspServer.RTSPClient.session_filter`()
Returns:	a `GstRtspServer.RTSPFilterResult`.
Return type:	`GstRtspServer.RTSPFilterResult`

This function will be called by the GstRtspServer.RTSPClient.session_filter(). An implementation should return a value of GstRtspServer.RTSPFilterResult.

When this function returns GstRtspServer.RTSPFilterResult.REMOVE, sess will be removed from client.

A return value of GstRtspServer.RTSPFilterResult.KEEP will leave sess untouched in client.

A value of GstRtspServer.RTSPFilterResult.REF will add sess to the result GLib.List of GstRtspServer.RTSPClient.session_filter().

GstRtspServer.RTSPKeepAliveFunc(*user_data)¶

Parameters:	user_data (`object` or `None`) – user `GstRtsp.data`

Function registered with GstRtspServer.RTSPStreamTransport.set_keepalive() and called when the stream is active.

GstRtspServer.RTSPMessageSentFunc(*user_data)¶

Parameters:	user_data (`object` or `None`) – user `GstRtsp.data`

Function registered with GstRtspServer.RTSPStreamTransport.set_message_sent() and called when a message has been sent on the transport.

GstRtspServer.RTSPMessageSentFuncFull(trans, *user_data)¶

Parameters:	trans (`GstRtspServer.RTSPStreamTransport`) – user_data (`object` or `None`) – user `GstRtsp.data`

Function registered with GstRtspServer.RTSPStreamTransport.set_message_sent_full() and called when a message has been sent on the transport.

New in version 1.18.

GstRtspServer.RTSPSendFunc(buffer, channel, *user_data)¶

Parameters:	buffer (`Gst.Buffer`) – a `Gst.Buffer` channel (`int`) – a channel user_data (`object` or `None`) – user `GstRtsp.data`
Returns:	`True` on success
Return type:	`bool`

Function registered with GstRtspServer.RTSPStreamTransport.set_callbacks() and called when buffer must be sent on channel.

GstRtspServer.RTSPSendListFunc(buffer_list, channel, *user_data)¶

Parameters:	buffer_list (`Gst.BufferList`) – a `Gst.BufferList` channel (`int`) – a channel user_data (`object` or `None`) – user `GstRtsp.data`
Returns:	`True` on success
Return type:	`bool`

Function registered with GstRtspServer.RTSPStreamTransport.set_callbacks() and called when buffer_list must be sent on channel.

New in version 1.16.

GstRtspServer.RTSPServerClientFilterFunc(server, client, *user_data)¶

Parameters:	server (`GstRtspServer.RTSPServer`) – a `GstRtspServer.RTSPServer` object client (`GstRtspServer.RTSPClient`) – a `GstRtspServer.RTSPClient` in server user_data (`object` or `None`) – user `GstRtsp.data` that has been given to `GstRtspServer.RTSPServer.client_filter`()
Returns:	a `GstRtspServer.RTSPFilterResult`.
Return type:	`GstRtspServer.RTSPFilterResult`

This function will be called by the GstRtspServer.RTSPServer.client_filter(). An implementation should return a value of GstRtspServer.RTSPFilterResult.

When this function returns GstRtspServer.RTSPFilterResult.REMOVE, client will be removed from server.

A return value of GstRtspServer.RTSPFilterResult.KEEP will leave client untouched in server.

A value of GstRtspServer.RTSPFilterResult.REF will add client to the result GLib.List of GstRtspServer.RTSPServer.client_filter().

GstRtspServer.RTSPSessionFilterFunc(sess, media, *user_data)¶

Parameters:	sess (`GstRtspServer.RTSPSession`) – a `GstRtspServer.RTSPSession` object media (`GstRtspServer.RTSPSessionMedia`) – a `GstRtspServer.RTSPSessionMedia` in sess user_data (`object` or `None`) – user `GstRtsp.data` that has been given to `GstRtspServer.RTSPSession.filter`()
Returns:	a `GstRtspServer.RTSPFilterResult`.
Return type:	`GstRtspServer.RTSPFilterResult`

This function will be called by the GstRtspServer.RTSPSession.filter(). An implementation should return a value of GstRtspServer.RTSPFilterResult.

When this function returns GstRtspServer.RTSPFilterResult.REMOVE, media will be removed from sess.

A return value of GstRtspServer.RTSPFilterResult.KEEP will leave media untouched in sess.

A value of GstRtspServer.RTSPFilterResult.REF will add media to the result GLib.List of GstRtspServer.RTSPSession.filter().

GstRtspServer.RTSPSessionPoolFilterFunc(pool, session, *user_data)¶

Parameters:	pool (`GstRtspServer.RTSPSessionPool`) – a `GstRtspServer.RTSPSessionPool` object session (`GstRtspServer.RTSPSession`) – a `GstRtspServer.RTSPSession` in pool user_data (`object` or `None`) – user `GstRtsp.data` that has been given to `GstRtspServer.RTSPSessionPool.filter`()
Returns:	a `GstRtspServer.RTSPFilterResult`.
Return type:	`GstRtspServer.RTSPFilterResult`

This function will be called by the GstRtspServer.RTSPSessionPool.filter(). An implementation should return a value of GstRtspServer.RTSPFilterResult.

When this function returns GstRtspServer.RTSPFilterResult.REMOVE, session will be removed from pool.

A return value of GstRtspServer.RTSPFilterResult.KEEP will leave session untouched in pool.

A value of GstRtspServer.RTSPFilterResult.REF will add session to the result GLib.List of GstRtspServer.RTSPSessionPool.filter().

GstRtspServer.RTSPSessionPoolFunc(pool, *user_data)¶

Parameters:	pool (`GstRtspServer.RTSPSessionPool`) – a `GstRtspServer.RTSPSessionPool` object user_data (`object` or `None`) – user `GstRtsp.data` that has been given when registering the handler
Returns:	`False` if the source should be removed.
Return type:	`bool`

The function that will be called from the GLib.Source watch on the session pool.

The function will be called when the pool must be cleaned up because one or more sessions timed out.

GstRtspServer.RTSPStreamTransportFilterFunc(stream, trans, *user_data)¶

Parameters:	stream (`GstRtspServer.RTSPStream`) – a `GstRtspServer.RTSPStream` object trans (`GstRtspServer.RTSPStreamTransport`) – a `GstRtspServer.RTSPStreamTransport` in stream user_data (`object` or `None`) – user `GstRtsp.data` that has been given to `GstRtspServer.RTSPStream.transport_filter`()
Returns:	a `GstRtspServer.RTSPFilterResult`.
Return type:	`GstRtspServer.RTSPFilterResult`

This function will be called by the GstRtspServer.RTSPStream.transport_filter(). An implementation should return a value of GstRtspServer.RTSPFilterResult.

When this function returns GstRtspServer.RTSPFilterResult.REMOVE, trans will be removed from stream.

A return value of GstRtspServer.RTSPFilterResult.KEEP will leave trans untouched in stream.

A value of GstRtspServer.RTSPFilterResult.REF will add trans to the result GLib.List of GstRtspServer.RTSPStream.transport_filter().