rtsp session

GstRtspServer.RTSPSession

GObject.Object
    ╰──GstRtspServer.RTSPSession

GstRtspServer.RTSPSession.prototype.new

function GstRtspServer.RTSPSession.prototype.new(sessionid: String): {
    // javascript wrapper for 'gst_rtsp_session_new'
}

Create a new GstRtspServer.RTSPSession instance with sessionid.

GstRtspServer.RTSPSession.prototype.allow_expire

function GstRtspServer.RTSPSession.prototype.allow_expire(): {
    // javascript wrapper for 'gst_rtsp_session_allow_expire'
}

Allow session to expire. This method must be called an equal amount of time as GstRtspServer.RTSPSession.prototype.prevent_expire.

GstRtspServer.RTSPSession.prototype.dup_media

function GstRtspServer.RTSPSession.prototype.dup_media(path: String): {
    // javascript wrapper for 'gst_rtsp_session_dup_media'
}

Gets the session media for path, increasing its reference count. matched will contain the number of matched characters of path.

Since : 1.20

GstRtspServer.RTSPSession.prototype.filter

function GstRtspServer.RTSPSession.prototype.filter(func: GstRtspServer.RTSPSessionFilterFunc, user_data: Object): {
    // javascript wrapper for 'gst_rtsp_session_filter'
}

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

If func returns GstRtspServer.RTSPFilterResult.REMOVE, the media will be removed from sess.

If func returns GstRtspServer.RTSPFilterResult.KEEP, the media will remain in sess.

If func returns GstRtspServer.RTSPFilterResult.REF, the media will remain in sess but will also be added with an additional ref to the result GLib.List of this function..

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

GstRtspServer.RTSPSession.prototype.get_header

function GstRtspServer.RTSPSession.prototype.get_header(): {
    // javascript wrapper for 'gst_rtsp_session_get_header'
}

Get the string that can be placed in the Session header field.

GstRtspServer.RTSPSession.prototype.get_media

function GstRtspServer.RTSPSession.prototype.get_media(path: String): {
    // javascript wrapper for 'gst_rtsp_session_get_media'
}

Gets the session media for path. matched will contain the number of matched characters of path.

GstRtspServer.RTSPSession.prototype.get_sessionid

function GstRtspServer.RTSPSession.prototype.get_sessionid(): {
    // javascript wrapper for 'gst_rtsp_session_get_sessionid'
}

Get the sessionid of session.

GstRtspServer.RTSPSession.prototype.get_timeout

function GstRtspServer.RTSPSession.prototype.get_timeout(): {
    // javascript wrapper for 'gst_rtsp_session_get_timeout'
}

Get the timeout value of session.

GstRtspServer.RTSPSession.prototype.is_expired

function GstRtspServer.RTSPSession.prototype.is_expired(now: GLib.TimeVal): {
    // javascript wrapper for 'gst_rtsp_session_is_expired'
}

Check if session timeout out.

deprecated : Use gst_rtsp_session_is_expired_usec() instead.

GstRtspServer.RTSPSession.prototype.is_expired_usec

function GstRtspServer.RTSPSession.prototype.is_expired_usec(now: Number): {
    // javascript wrapper for 'gst_rtsp_session_is_expired_usec'
}

Check if session timeout out.

GstRtspServer.RTSPSession.prototype.manage_media

function GstRtspServer.RTSPSession.prototype.manage_media(path: String, media: GstRtspServer.RTSPMedia): {
    // javascript wrapper for 'gst_rtsp_session_manage_media'
}

Manage the media object obj in sess. path will be used to retrieve this media from the session with GstRtspServer.RTSPSession.prototype.get_media.

Ownership is taken from media.

GstRtspServer.RTSPSession.prototype.next_timeout

function GstRtspServer.RTSPSession.prototype.next_timeout(now: GLib.TimeVal): {
    // javascript wrapper for 'gst_rtsp_session_next_timeout'
}

Get the amount of milliseconds till the session will expire.

deprecated : Use gst_rtsp_session_next_timeout_usec() instead.

GstRtspServer.RTSPSession.prototype.next_timeout_usec

function GstRtspServer.RTSPSession.prototype.next_timeout_usec(now: Number): {
    // javascript wrapper for 'gst_rtsp_session_next_timeout_usec'
}

Get the amount of milliseconds till the session will expire.

GstRtspServer.RTSPSession.prototype.prevent_expire

function GstRtspServer.RTSPSession.prototype.prevent_expire(): {
    // javascript wrapper for 'gst_rtsp_session_prevent_expire'
}

Prevent session from expiring.

GstRtspServer.RTSPSession.prototype.release_media

function GstRtspServer.RTSPSession.prototype.release_media(media: GstRtspServer.RTSPSessionMedia): {
    // javascript wrapper for 'gst_rtsp_session_release_media'
}

Release the managed media in sess, freeing the memory allocated by it.

GstRtspServer.RTSPSession.prototype.set_timeout

function GstRtspServer.RTSPSession.prototype.set_timeout(timeout: Number): {
    // javascript wrapper for 'gst_rtsp_session_set_timeout'
}

Configure session for a timeout of timeout seconds. The session will be cleaned up when there is no activity for timeout seconds.

GstRtspServer.RTSPSession.prototype.touch

function GstRtspServer.RTSPSession.prototype.touch(): {
    // javascript wrapper for 'gst_rtsp_session_touch'
}

Update the last_access time of the session to the current time.

extra-timeout

“extra-timeout” Number

Flags : Read / Write

sessionid

“sessionid” String

Flags : Read / Write / Construct Only

timeout

“timeout” Number

Flags : Read / Write

timeout-always-visible

“timeout-always-visible” Number

Flags : Read / Write

GstRtspServer.RTSPFilterResult

Possible return values for GstRtspServer.RTSPSessionPool.prototype.filter.

GstRtspServer.RTSPSessionFilterFunc

function GstRtspServer.RTSPSessionFilterFunc(sess: GstRtspServer.RTSPSession, media: GstRtspServer.RTSPSessionMedia, user_data: Object): {
    // javascript wrapper for 'GstRTSPSessionFilterFunc'
}

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