Crate videostream_sys

Structs

• vsl_client
• vsl_frame
• vsl_host

Functions

• vsl_client_disconnect^⚠
  Disconnects from the VSLHost and stops all reconnection attempts. This should be called as part of closing down a VSL client session. It is thread-safe unlike vsl_client_release which disposes of the client object.
• vsl_client_init^⚠
  Creates a client and connects to the host at the provided path. If the connection cannot be made NULL is returned and errno is set.
• vsl_client_path^⚠
  Returns the path on which the client has connected to the host.
• vsl_client_release^⚠
  Releases the client, disconnecting from the host and releasing allocated memory.
• vsl_client_set_timeout^⚠
  Sets the socket timeout for this client.
• vsl_client_userptr^⚠
  Returns the optional userptr associated with this client connection.
• vsl_frame_dts^⚠
  Returns the decode timestamp for this frame in nanoseconds.
• vsl_frame_duration^⚠
  Returns the duration for this frame in nanoseconds.
• vsl_frame_expires^⚠
  Returns the epiration time for this frame in milliseconds.
• vsl_frame_fourcc^⚠
  Returns the FOURCC code for the video frame.
• vsl_frame_handle^⚠
  Returns the file descriptor for this frame or -1 if none is associated.
• vsl_frame_height^⚠
  Returns the height in pixels of the video frame.
• vsl_frame_mmap^⚠
  Maps the frame into the process’ memory space, optionally also sets the size of the frame if @param size is non-NULL. Ensure the frame is unmapped when no longer needed using @ref nn_frame_munmap().
• vsl_frame_munmap^⚠
  Maps the frame into the process’ memory space, optionally also sets the size of the frame if @param size is non-NULL.
• vsl_frame_paddr^⚠
  Returns the physical address of the frame. If the frame does not support DMA then MMAP_FAILED is returned.
• vsl_frame_pts^⚠
  Returns the presentation timestamp for this frame in nanoseconds.
• vsl_frame_register^⚠
  Registers the video frame along with optional user pointer to any arbitrary data. Typically it would be used for holding a reference to the host’s view of the frame handle.
• vsl_frame_release^⚠
  Releases a client side frame and frees any allocated memory. You should first unmap and unlock the video frame before releasing it.
• vsl_frame_serial^⚠
  Returns the serial frame count of the video frame.
• vsl_frame_set_userptr^⚠
  Associate userptr with this frame.
• vsl_frame_size^⚠
  Returns the size in bytes of the video frame.
• vsl_frame_timestamp^⚠
  Returns the timestamp for this frame in nanoseconds.
• vsl_frame_trylock^⚠
  Attempts to lock the video frame.
• vsl_frame_unlock^⚠
  Attempts to unlock the video frame.
• vsl_frame_unregister^⚠
  Unregisters the frame, removing it from the host pool.
• vsl_frame_userptr^⚠
  Returns the user pointer associated with this frame.
• vsl_frame_wait^⚠
  Waits for a frame to arrive and returns a new frame object. Frames who’s timestamp is less than @param until will be ignored.
• vsl_frame_width^⚠
  Returns the width in pixels of the video frame.
• vsl_host_init^⚠
  Creates a host on the requested path. If the path is unavailable because of permissions or already exists then NULL is returned and errno is set.
• vsl_host_path^⚠
  Returns the bound path of the host.
• vsl_host_poll^⚠
  Polls the list of available connections in our pool. If @param wait is >0 then poll will timeout after @param wait milliseconds. Note frames are only expired by the @ref vsl_host_process function so the @param wait parameter should be some value no greater than the desired expiration time.
• vsl_host_process^⚠
  Process the host tasks by first expiring old frames and then servicing the first available connection in our pool. This function should be called in a loop, generally blocked by @ref vsl_host_poll.
• vsl_host_release^⚠
  Releases the host, disconnecting all clients and releasing any allocated memory.
• vsl_host_service^⚠
  Services the client socket.
• vsl_host_sockets^⚠
  Request a copy of the sockets managed by the host. There will always be at least one socket which is the connection socket which accepts new connections. Up to n_sockets socket descriptors will be copied into the sockets buffer, if n_sockets is fewer than the number of available sockets errno will be set to ENOBUFS. The n_socket parameter, if provided, will be populated with a value of n_clients+1 which can be used to query required space for the sockets buffer. It is suggested to provide a buffer which is larger than max_sockets to avoid race conditions where the number of sockets changes between calls to this function.
• vsl_timestamp^⚠
• vsl_version^⚠
  Returns the VideoStream Library version.

Type Definitions

• VSLClient
  The VSLClient object manages a single connection to a VSLHost.
• VSLFrame
  The VSLFrame object represents a single video frame from either the host or client perspective. Certain API are only available to the host or client.
• VSLHost
  The VSLHost object manages a connection point at the user-defined path and allows frames to be registered for client use.
• vsl_frame_cleanup
  Function pointer definition which will be called as part of @ref vsl_frame_unregister. This is typically used to free resources associated with the frame on either client or host side.