GstRtspServer.RTSPServer

GObject.Object
    ╰──GstRtspServer.RTSPServer
        ╰──GstRtspServer.RTSPOnvifServer

GstRtspServer.RTSPServer.prototype.new

function GstRtspServer.RTSPServer.prototype.new(): {
    // javascript wrapper for 'gst_rtsp_server_new'
}

Create a new GstRtspServer.RTSPServer instance.

GstRtspServer.RTSPServer.prototype.attach

function GstRtspServer.RTSPServer.prototype.attach(context: GLib.MainContext): {
    // javascript wrapper for 'gst_rtsp_server_attach'
}

Attaches server to context. When the mainloop for context is run, the server will be dispatched. When context is null, the default context will be used).

This function should be called when the server properties and urls are fully configured and the server is ready to start.

This takes a reference on server until the source is destroyed. Note that if context is not the default main context as returned by GLib.prototype.main_context_default (or null), GLib.prototype.source_remove cannot be used to destroy the source. In that case it is recommended to use GstRtspServer.RTSPServer.prototype.create_source and attach it to context manually.

GstRtspServer.RTSPServer.prototype.client_filter

function GstRtspServer.RTSPServer.prototype.client_filter(func: GstRtspServer.RTSPServerClientFilterFunc, user_data: Object): {
    // javascript wrapper for 'gst_rtsp_server_client_filter'
}

Call func for each client managed by server. The result value of func determines what happens to the client. func will be called with server locked so no further actions on server can be performed from func.

If func returns GstRtspServer.RTSPFilterResult.REMOVE, the client will be removed from server.

If func returns GstRtspServer.RTSPFilterResult.KEEP, the client will remain in server.

If func returns GstRtspServer.RTSPFilterResult.REF, the client will remain in server 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 each client.

GstRtspServer.RTSPServer.prototype.create_socket

function GstRtspServer.RTSPServer.prototype.create_socket(cancellable: Gio.Cancellable): {
    // javascript wrapper for 'gst_rtsp_server_create_socket'
}

Create a Gio.Socket for server. The socket will listen on the configured service.

GstRtspServer.RTSPServer.prototype.create_source

function GstRtspServer.RTSPServer.prototype.create_source(cancellable: Gio.Cancellable): {
    // javascript wrapper for 'gst_rtsp_server_create_source'
}

Create a GLib.Source for server. The new source will have a default Gio.SocketSourceFunc of GstRtspServer.RTSPServer.prototype.io_func.

cancellable if not null can be used to cancel the source, which will cause the source to trigger, reporting the current condition (which is likely 0 unless cancellation happened at the same time as a condition change). You can check for this in the callback using Gio.Cancellable.prototype.is_cancelled.

This takes a reference on server until source is destroyed.

GstRtspServer.RTSPServer.prototype.get_address

function GstRtspServer.RTSPServer.prototype.get_address(): {
    // javascript wrapper for 'gst_rtsp_server_get_address'
}

Get the address on which the server will accept connections.

GstRtspServer.RTSPServer.prototype.get_auth

function GstRtspServer.RTSPServer.prototype.get_auth(): {
    // javascript wrapper for 'gst_rtsp_server_get_auth'
}

Get the GstRtspServer.RTSPAuth used as the authentication manager of server.

GstRtspServer.RTSPServer.prototype.get_backlog

function GstRtspServer.RTSPServer.prototype.get_backlog(): {
    // javascript wrapper for 'gst_rtsp_server_get_backlog'
}

The maximum amount of queued requests for the server.

GstRtspServer.RTSPServer.prototype.get_bound_port

function GstRtspServer.RTSPServer.prototype.get_bound_port(): {
    // javascript wrapper for 'gst_rtsp_server_get_bound_port'
}

Get the port number where the server was bound to.

GstRtspServer.RTSPServer.prototype.get_content_length_limit

function GstRtspServer.RTSPServer.prototype.get_content_length_limit(): {
    // javascript wrapper for 'gst_rtsp_server_get_content_length_limit'
}

Get the Content-Length limit of server.

Since : 1.18

GstRtspServer.RTSPServer.prototype.get_mount_points

function GstRtspServer.RTSPServer.prototype.get_mount_points(): {
    // javascript wrapper for 'gst_rtsp_server_get_mount_points'
}

Get the GstRtspServer.RTSPMountPoints used as the mount points of server.

GstRtspServer.RTSPServer.prototype.get_service

function GstRtspServer.RTSPServer.prototype.get_service(): {
    // javascript wrapper for 'gst_rtsp_server_get_service'
}

Get the service on which the server will accept connections.

GstRtspServer.RTSPServer.prototype.get_session_pool

function GstRtspServer.RTSPServer.prototype.get_session_pool(): {
    // javascript wrapper for 'gst_rtsp_server_get_session_pool'
}

Get the GstRtspServer.RTSPSessionPool used as the session pool of server.

GstRtspServer.RTSPServer.prototype.get_thread_pool

function GstRtspServer.RTSPServer.prototype.get_thread_pool(): {
    // javascript wrapper for 'gst_rtsp_server_get_thread_pool'
}

Get the GstRtspServer.RTSPThreadPool used as the thread pool of server.

GstRtspServer.RTSPServer.prototype.set_address

function GstRtspServer.RTSPServer.prototype.set_address(address: String): {
    // javascript wrapper for 'gst_rtsp_server_set_address'
}

Configure server to accept connections on the given address.

This function must be called before the server is bound.

GstRtspServer.RTSPServer.prototype.set_auth

function GstRtspServer.RTSPServer.prototype.set_auth(auth: GstRtspServer.RTSPAuth): {
    // javascript wrapper for 'gst_rtsp_server_set_auth'
}

configure auth to be used as the authentication manager of server.

GstRtspServer.RTSPServer.prototype.set_backlog

function GstRtspServer.RTSPServer.prototype.set_backlog(backlog: Number): {
    // javascript wrapper for 'gst_rtsp_server_set_backlog'
}

configure the maximum amount of requests that may be queued for the server.

This function must be called before the server is bound.

GstRtspServer.RTSPServer.prototype.set_content_length_limit

function GstRtspServer.RTSPServer.prototype.set_content_length_limit(limit: Number): {
    // javascript wrapper for 'gst_rtsp_server_set_content_length_limit'
}

Define an appropriate request size limit and reject requests exceeding the limit.

Since : 1.18

GstRtspServer.RTSPServer.prototype.set_mount_points

function GstRtspServer.RTSPServer.prototype.set_mount_points(mounts: GstRtspServer.RTSPMountPoints): {
    // javascript wrapper for 'gst_rtsp_server_set_mount_points'
}

configure mounts to be used as the mount points of server.

GstRtspServer.RTSPServer.prototype.set_service

function GstRtspServer.RTSPServer.prototype.set_service(service: String): {
    // javascript wrapper for 'gst_rtsp_server_set_service'
}

Configure server to accept connections on the given service. service should be a string containing the service name (see services(5)) or a string containing a port number between 1 and 65535.

When service is set to "0", the server will listen on a random free port. The actual used port can be retrieved with GstRtspServer.RTSPServer.prototype.get_bound_port.

This function must be called before the server is bound.

GstRtspServer.RTSPServer.prototype.set_session_pool

function GstRtspServer.RTSPServer.prototype.set_session_pool(pool: GstRtspServer.RTSPSessionPool): {
    // javascript wrapper for 'gst_rtsp_server_set_session_pool'
}

configure pool to be used as the session pool of server.

GstRtspServer.RTSPServer.prototype.set_thread_pool

function GstRtspServer.RTSPServer.prototype.set_thread_pool(pool: GstRtspServer.RTSPThreadPool): {
    // javascript wrapper for 'gst_rtsp_server_set_thread_pool'
}

configure pool to be used as the thread pool of server.

GstRtspServer.RTSPServer.prototype.transfer_connection

function GstRtspServer.RTSPServer.prototype.transfer_connection(socket: Gio.Socket, ip: String, port: Number, initial_buffer: String): {
    // javascript wrapper for 'gst_rtsp_server_transfer_connection'
}

Take an existing network socket and use it for an RTSP connection. This is used when transferring a socket from an HTTP server which should be used as an RTSP over HTTP tunnel. The initial_buffer contains any remaining data that the HTTP server read from the socket while parsing the HTTP header.

GstRtspServer.RTSPServer.prototype.io_func

function GstRtspServer.RTSPServer.prototype.io_func(socket: Gio.Socket, condition: GLib.IOCondition, server: GstRtspServer.RTSPServer): {
    // javascript wrapper for 'gst_rtsp_server_io_func'
}

A default Gio.SocketSourceFunc that creates a new GstRtspServer.RTSPClient to accept and handle a new connection on socket or server.

client-connected

function client_connected_callback(self: GstRtspServer.RTSPServer, object: GstRtspServer.RTSPClient, user_data: Object): {
    // javascript callback for the 'client-connected' signal
}

Flags: Run Last

address

“address” String

Flags : Read / Write

backlog

“backlog” Number

Flags : Read / Write

bound-port

“bound-port” Number

Flags : Read

content-length-limit

“content-length-limit” Number

Flags : Read / Write

mount-points

“mount-points” GstRtspServer.RTSPMountPoints

Flags : Read / Write

service

“service” String

Flags : Read / Write

session-pool

“session-pool” GstRtspServer.RTSPSessionPool

Flags : Read / Write

vfunc_client_connected

function vfunc_client_connected(server: GstRtspServer.RTSPServer, client: GstRtspServer.RTSPClient): {
    // javascript implementation of the 'client_connected' virtual method
}

emitted when a new client connected.

GstRtspServer.RTSPServerClientFilterFunc

function GstRtspServer.RTSPServerClientFilterFunc(server: GstRtspServer.RTSPServer, client: GstRtspServer.RTSPClient, user_data: Object): {
    // javascript wrapper for 'GstRTSPServerClientFilterFunc'
}

This function will be called by the GstRtspServer.RTSPServer.prototype.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.prototype.client_filter.