Gjsify LogoGjsify Logo

Opaque RTSP watch object that can be used for asynchronous RTSP operations.

record

Hierarchy

  • RTSPWatch

Index

Constructors

Properties

name: string

Methods

  • Adds a #GstRTSPWatch to a context so that it will be executed within that context.

    Parameters

    • context: MainContext

      a GMainContext (if NULL, the default context will be used)

    Returns number

  • get_send_backlog(): [number, number]
  • Get the maximum amount of bytes and messages that will be queued in watch. See gst_rtsp_watch_set_send_backlog().

    Returns [number, number]

  • reset(): void
  • Reset watch, this is usually called after gst_rtsp_connection_do_tunnel() when the file descriptors of the connection might have changed.

    Returns void

  • Send a message using the connection of the watch. If it cannot be sent immediately, it will be queued for transmission in watch. The contents of message will then be serialized and transmitted when the connection of the watch becomes writable. In case the message is queued, the ID returned in id will be non-zero and used as the ID argument in the message_sent callback.

    Parameters

    Returns [RTSPResult, number]

  • Sends messages using the connection of the watch. If they cannot be sent immediately, they will be queued for transmission in watch. The contents of messages will then be serialized and transmitted when the connection of the watch becomes writable. In case the messages are queued, the ID returned in id will be non-zero and used as the ID argument in the message_sent callback once the last message is sent. The callback will only be called once for the last message.

    Parameters

    Returns [RTSPResult, number]

  • set_flushing(flushing: boolean): void
  • When flushing is %TRUE, abort a call to gst_rtsp_watch_wait_backlog() and make sure gst_rtsp_watch_write_data() returns immediately with #GST_RTSP_EINTR. And empty the queue.

    Parameters

    • flushing: boolean

      new flushing state

    Returns void

  • set_send_backlog(bytes: number, messages: number): void
  • Set the maximum amount of bytes and messages that will be queued in watch. When the maximum amounts are exceeded, gst_rtsp_watch_write_data() and gst_rtsp_watch_send_message() will return #GST_RTSP_ENOMEM.

    A value of 0 for bytes or messages means no limits.

    Parameters

    • bytes: number

      maximum bytes

    • messages: number

      maximum messages

    Returns void

  • unref(): void
  • Decreases the reference count of watch by one. If the resulting reference count is zero the watch and associated memory will be destroyed.

    Returns void

  • Wait until there is place in the backlog queue, timeout is reached or watch is set to flushing.

    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.

    The typically use of this function is when gst_rtsp_watch_write_data returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for free space in the backlog queue and try again.

    Parameters

    • timeout: TimeVal

      a GTimeVal timeout

    Returns RTSPResult

  • Wait until there is place in the backlog queue, timeout is reached or watch is set to flushing.

    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.

    The typically use of this function is when gst_rtsp_watch_write_data returns %GST_RTSP_ENOMEM. The caller then calls this function to wait for free space in the backlog queue and try again.

    Parameters

    • timeout: number

      a timeout in microseconds

    Returns RTSPResult

  • write_data(data: Uint8Array): [RTSPResult, number]
  • Write data using the connection of the watch. If it cannot be sent immediately, it will be queued for transmission in watch. The contents of message will then be serialized and transmitted when the connection of the watch becomes writable. In case the message is queued, the ID returned in id will be non-zero and used as the ID argument in the message_sent callback.

    This function will take ownership of data and g_free() it after use.

    If the amount of queued data exceeds the limits set with gst_rtsp_watch_set_send_backlog(), this function will return #GST_RTSP_ENOMEM.

    Parameters

    • data: Uint8Array

      the data to queue

    Returns [RTSPResult, number]

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