rtsp session pool

GstRtspServer.RTSPSessionPool

GObject.Object
    ╰──GstRtspServer.RTSPSessionPool

GstRtspServer.RTSPSessionPool.prototype.new

function GstRtspServer.RTSPSessionPool.prototype.new(): {
    // javascript wrapper for 'gst_rtsp_session_pool_new'
}

Create a new GstRtspServer.RTSPSessionPool instance.

GstRtspServer.RTSPSessionPool.prototype.cleanup

function GstRtspServer.RTSPSessionPool.prototype.cleanup(): {
    // javascript wrapper for 'gst_rtsp_session_pool_cleanup'
}

Inspect all the sessions in pool and remove the sessions that are inactive for more than their timeout.

GstRtspServer.RTSPSessionPool.prototype.create

function GstRtspServer.RTSPSessionPool.prototype.create(): {
    // javascript wrapper for 'gst_rtsp_session_pool_create'
}

Create a new GstRtspServer.RTSPSession object in pool.

GstRtspServer.RTSPSessionPool.prototype.create_watch

function GstRtspServer.RTSPSessionPool.prototype.create_watch(): {
    // javascript wrapper for 'gst_rtsp_session_pool_create_watch'
}

Create a GSource (not introspectable) that will be dispatched when the session should be cleaned up.

GstRtspServer.RTSPSessionPool.prototype.filter

function GstRtspServer.RTSPSessionPool.prototype.filter(func: GstRtspServer.RTSPSessionPoolFilterFunc, user_data: Object): {
    // javascript wrapper for 'gst_rtsp_session_pool_filter'
}

Call func for each session in pool. The result value of func determines what happens to the session. func will be called with the session pool locked so no further actions on pool can be performed from func.

If func returns GstRtspServer.RTSPFilterResult.REMOVE, the session will be set to the expired state and removed from pool.

If func returns GstRtspServer.RTSPFilterResult.KEEP, the session will remain in pool.

If func returns GstRtspServer.RTSPFilterResult.REF, the session will remain in pool but will also be added with an additional ref to the result GList of this function..

When func is null, GstRtspServer.RTSPFilterResult.REF will be assumed for all sessions.

GstRtspServer.RTSPSessionPool.prototype.find

function GstRtspServer.RTSPSessionPool.prototype.find(sessionid: String): {
    // javascript wrapper for 'gst_rtsp_session_pool_find'
}

Find the session with sessionid in pool. The access time of the session will be updated with GstRtspServer.RTSPSession.prototype.touch.

GstRtspServer.RTSPSessionPool.prototype.get_max_sessions

function GstRtspServer.RTSPSessionPool.prototype.get_max_sessions(): {
    // javascript wrapper for 'gst_rtsp_session_pool_get_max_sessions'
}

Get the maximum allowed number of sessions in pool. 0 means an unlimited amount of sessions.

GstRtspServer.RTSPSessionPool.prototype.get_n_sessions

function GstRtspServer.RTSPSessionPool.prototype.get_n_sessions(): {
    // javascript wrapper for 'gst_rtsp_session_pool_get_n_sessions'
}

Get the amount of active sessions in pool.

GstRtspServer.RTSPSessionPool.prototype.remove

function GstRtspServer.RTSPSessionPool.prototype.remove(sess: GstRtspServer.RTSPSession): {
    // javascript wrapper for 'gst_rtsp_session_pool_remove'
}

Remove sess from pool, releasing the ref that the pool has on sess.

GstRtspServer.RTSPSessionPool.prototype.set_max_sessions

function GstRtspServer.RTSPSessionPool.prototype.set_max_sessions(max: Number): {
    // javascript wrapper for 'gst_rtsp_session_pool_set_max_sessions'
}

Configure the maximum allowed number of sessions in pool to max. A value of 0 means an unlimited amount of sessions.

session-removed

function session_removed_callback(self: GstRtspServer.RTSPSessionPool, object: GstRtspServer.RTSPSession, user_data: Object): {
    // javascript callback for the 'session-removed' signal
}

Flags: Run Last

max-sessions

“max-sessions” Number

Flags : Read / Write

vfunc_create_session_id

function vfunc_create_session_id(pool: GstRtspServer.RTSPSessionPool): {
    // javascript implementation of the 'create_session_id' virtual method
}

create a new random session id. Subclasses can create custom session ids and should not check if the session exists.

vfunc_session_removed

function vfunc_session_removed(pool: GstRtspServer.RTSPSessionPool, session: GstRtspServer.RTSPSession): {
    // javascript implementation of the 'session_removed' virtual method
}

a session was removed from the pool

GstRtspServer.RTSPSessionPoolFilterFunc

function GstRtspServer.RTSPSessionPoolFilterFunc(pool: GstRtspServer.RTSPSessionPool, session: GstRtspServer.RTSPSession, user_data: Object): {
    // javascript wrapper for 'GstRTSPSessionPoolFilterFunc'
}

This function will be called by the GstRtspServer.RTSPSessionPool.prototype.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 GST_RTSP_FILTER_REF will add session to the result GLib.List of GstRtspServer.RTSPSessionPool.prototype.filter.

GstRtspServer.RTSPSessionPoolFunc

function GstRtspServer.RTSPSessionPoolFunc(pool: GstRtspServer.RTSPSessionPool, user_data: Object): {
    // javascript wrapper for 'GstRTSPSessionPoolFunc'
}

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

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