Gjsify LogoGjsify Logo

This object manages the RTSP connection to the server. It provides function to receive and send bytes and messages.

record

Hierarchy

  • RTSPConnection

Index

Constructors

Properties

name: string

Methods

  • clear_auth_params(): void
  • Attempt to connect to the url of conn made with gst_rtsp_connection_create(). If timeout is %NULL this function can block forever. If timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • timeout: TimeVal

      a GTimeVal timeout

    Returns RTSPResult

  • Attempt to connect to the url of conn made with gst_rtsp_connection_create(). If timeout is 0 this function can block forever. If timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • timeout: number

      a timeout in microseconds

    Returns RTSPResult

  • Attempt to connect to the url of conn made with gst_rtsp_connection_create(). If timeout is %NULL this function can block forever. If timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. If conn is set to tunneled, response will contain a response to the tunneling request messages.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    Returns RTSPResult

  • Attempt to connect to the url of conn made with gst_rtsp_connection_create(). If timeout is 0 this function can block forever. If timeout contains a valid timeout, this function will return #GST_RTSP_ETIMEOUT after the timeout expired. If conn is set to tunneled, response will contain a response to the tunneling request messages.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • timeout: number

      a timeout in microseconds

    • response: RTSPMessage

      a #GstRTSPMessage

    Returns RTSPResult

  • If conn received the first tunnel connection and conn2 received the second tunnel connection, link the two connections together so that conn manages the tunneled connection.

    After this call, conn2 cannot be used anymore and must be freed with gst_rtsp_connection_free().

    If conn2 is %NULL then only the base64 decoding context will be setup for conn.

    Parameters

    Returns RTSPResult

  • Start or stop the flushing action on conn. When flushing, all current and future actions on conn will return #GST_RTSP_EINTR until the connection is set to non-flushing mode again.

    Parameters

    • flush: boolean

      start or stop the flush

    Returns RTSPResult

  • get_ignore_x_server_reply(): boolean
  • get_ip(): string
  • get_remember_session_id(): boolean
  • Get the TLS connection of conn.

    For client side this will return the #GTlsClientConnection when connected over TLS.

    For server side connections, this function will create a GTlsServerConnection when called the first time and will return that same connection on subsequent calls. The server is then responsible for configuring the TLS connection.

    Returns TlsConnection

  • Gets a #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary.

    Returns TlsInteraction

  • get_tunnelid(): string
  • is_tunneled(): boolean
  • next_timeout_usec(): number
  • Wait up to the specified timeout for the connection to become available for at least one of the operations specified in events. When the function returns with #GST_RTSP_OK, revents will contain a bitmask of available operations on conn.

    timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • events: RTSPEvent

      a bitmask of #GstRTSPEvent flags to check

    • revents: RTSPEvent

      location for result flags

    • timeout: TimeVal

      a timeout

    Returns RTSPResult

  • Wait up to the specified timeout for the connection to become available for at least one of the operations specified in events. When the function returns with #GST_RTSP_OK, revents will contain a bitmask of available operations on conn.

    timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • events: RTSPEvent

      a bitmask of #GstRTSPEvent flags to check

    • revents: RTSPEvent

      location for result flags

    • timeout: number

      a timeout in microseconds

    Returns RTSPResult

  • Attempt to read size bytes into data from the connected conn, blocking up to the specified timeout. timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • data: number

      the data to read

    • size: number

      the size of data

    • timeout: TimeVal

      a timeout value or %NULL

    Returns RTSPResult

  • read_usec(data: number, size: number, timeout: number): RTSPResult
  • Attempt to read size bytes into data from the connected conn, blocking up to the specified timeout. timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • data: number

      the data to read

    • size: number

      the size of data

    • timeout: number

      a timeout value in microseconds

    Returns RTSPResult

  • Attempt to read into message from the connected conn, blocking up to the specified timeout. timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    Returns RTSPResult

  • Attempt to read into message from the connected conn, blocking up to the specified timeout. timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • message: RTSPMessage

      the message to read

    • timeout: number

      a timeout value or 0

    Returns RTSPResult

  • Attempt to send message to the connected conn, blocking up to the specified timeout. timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    Returns RTSPResult

  • Attempt to send messages to the connected conn, blocking up to the specified timeout. timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    Returns RTSPResult

  • Attempt to send messages to the connected conn, blocking up to the specified timeout. timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • messages: RTSPMessage[]

      the messages to send

    • timeout: number

      a timeout value in microseconds

    Returns RTSPResult

  • Attempt to send message to the connected conn, blocking up to the specified timeout. timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • message: RTSPMessage

      the message to send

    • timeout: number

      a timeout value in microseconds

    Returns RTSPResult

  • Sets a custom accept-certificate function for checking certificates for validity. This will directly map to #GTlsConnection 's "accept-certificate" signal and be performed after the default checks of #GstRTSPConnection (checking against the #GTlsDatabase with the given #GTlsCertificateFlags) have failed. If no #GTlsDatabase is set on this connection, only func will be called.

    Parameters

    Returns void

  • set_auth_param(param: string, value: string): void
  • Setup conn with authentication directives. This is not necessary for methods #GST_RTSP_AUTH_NONE and #GST_RTSP_AUTH_BASIC. For #GST_RTSP_AUTH_DIGEST, directives should be taken from the digest challenge in the WWW-Authenticate response header and can include realm, domain, nonce, opaque, stale, algorithm, qop as per RFC2617.

    Parameters

    • param: string

      authentication directive

    • value: string

      value

    Returns void

  • set_content_length_limit(limit: number): void
  • Configure conn to use the specified Content-Length limit. Both requests and responses are validated. If content-length is exceeded, ENOMEM error will be returned.

    Parameters

    • limit: number

      Content-Length limit

    Returns void

  • set_http_mode(enable: boolean): void
  • By setting the HTTP mode to %TRUE the message parsing will support HTTP messages in addition to the RTSP messages. It will also disable the automatic handling of setting up an HTTP tunnel.

    Parameters

    • enable: boolean

      %TRUE to enable manual HTTP mode

    Returns void

  • set_ignore_x_server_reply(ignore: boolean): void
  • Set whether to ignore the x-server-ip-address header reply or not. If the header is ignored, the original address will be used instead.

    Parameters

    • ignore: boolean

      %TRUE to ignore the x-server-ip-address header reply or %FALSE to comply with it (%FALSE is the default).

    Returns void

  • set_ip(ip: string): void
  • set_remember_session_id(remember: boolean): void
  • Sets if the #GstRTSPConnection should remember the session id from the last response received and force it onto any further requests.

    The default value is %TRUE

    Parameters

    • remember: boolean

      %TRUE if the connection should remember the session id

    Returns void

  • Sets the anchor certificate authorities database. This certificate database will be used to verify the server's certificate in case it can't be verified with the default certificate database first.

    Parameters

    Returns void

  • Sets a #GTlsInteraction object to be used when the connection or certificate database need to interact with the user. This will be used to prompt the user for passwords where necessary.

    Parameters

    Returns void

  • set_tunneled(tunneled: boolean): void
  • Set the HTTP tunneling state of the connection. This must be configured before the conn is connected.

    Parameters

    • tunneled: boolean

      the new state

    Returns void

  • Attempt to write size bytes of data to the connected conn, blocking up to the specified timeout. timeout can be %NULL, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • data: number

      the data to write

    • size: number

      the size of data

    • timeout: TimeVal

      a timeout value or %NULL

    Returns RTSPResult

  • write_usec(data: number, size: number, timeout: number): RTSPResult
  • Attempt to write size bytes of data to the connected conn, blocking up to the specified timeout. timeout can be 0, in which case this function might block forever.

    This function can be cancelled with gst_rtsp_connection_flush().

    Parameters

    • data: number

      the data to write

    • size: number

      the size of data

    • timeout: number

      a timeout value or 0

    Returns RTSPResult

  • Create a new #GstRTSPConnection for handling communication on the existing socket socket. The initial_buffer contains zero terminated data already read from socket which should be used before starting to read new data.

    Parameters

    • socket: Gio.Socket

      a #GSocket

    • ip: string

      the IP address of the other end

    • port: number

      the port used by the other end

    • initial_buffer: string

      data already read from fd

    Returns [RTSPResult, RTSPConnection]

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method