Media Communications Mesh#

Contents

• User Manual
  • Introduction
  • Mesh topology example
  • Terminology
  • Implemented Features
  • Planned Features
  • Core software components
  • Integration with media streaming software
  • Setup and Run
  • Performance
  • Known issues and limitations
  • Support
• License

Software Components

• Mesh Agent
  • Command line arguments
  • Example
• Media Proxy
  • Command line arguments
  • Environment variables
  • Run standalone
  • Run using native_af_xdp
  • Run in Docker
• SDK
  • General workflow
  • Usage scenarios
• FFmpeg Plugin
  • Build and install steps
  • Muxers and Demuxers
  • Media Proxy SDK API address configuration
  • Command line arguments
  • Example – Run video transmission
  • Example – Run audio transmission, PCM 24-bit
  • Troubleshooting

SDK

• SDK Overview
  • General workflow
  • Usage scenarios
• SDK API Definition
  • mesh_create_client()
  • mesh_delete_client()
  • mesh_create_tx_connection()
  • MeshConnection
  • mesh_create_rx_connection()
  • mesh_delete_connection()
  • mesh_get_buffer()
  • mesh_get_buffer_timeout()
  • MeshBuffer
  • mesh_put_buffer()
  • mesh_put_buffer_timeout()
  • mesh_buffer_set_payload_len()
  • mesh_buffer_set_metadata_len()
  • mesh_err2str()
  • Return error codes
• Examples
  • SMPTE ST 2110-20 uncompressed video receiver example
  • SMPTE ST 2110-20 uncompressed video sender example

Setup and Run

• Setup Guide
  • Prerequisites
  • Build and install steps
  • Build for Docker
• Runbook
  • Mesh cluster
  • Run Mesh Agent on a Control Node
  • Run Media Proxy on a Worker Node
  • Run user apps on a Worker Node
• Performance Notes
  • Configuration options
  • Known performance issues – How to resolve

Other

• Sphinx Build
  • 1. Prerequisites (Debian)
  • 2. Build HTML documentation
  • 3. Open created HTML documentation
• Contributing
  • Development
  • Coding Style
  • Issues
• Security
  • Reporting a Vulnerability
• Changelog
  • Release version: 25.03
  • Release version: 24.09
  • Release version: 24.06