qiurui
/
uvgrtp-base
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
uvgrtp-base/examples
History
Heikki Tampio 4e32cb7754 examples: Input V3C test file name as a command-line parameter 2024-01-30 11:43:24 +02:00
..
v3c examples: Improve documentation in V3C examples 2024-01-30 11:43:20 +02:00
.gitignore examples: Move examples folder to repo root 2022-02-28 09:52:18 +02:00
CMakeLists.txt v3c: Move V3C utility files to examples folder 2024-01-12 13:15:01 +02:00
README.md examples: Input V3C test file name as a command-line parameter 2024-01-30 11:43:24 +02:00
binding.cc examples: Update examples to use new create_session API 2024-01-30 11:43:22 +02:00
configuration.cc examples: Update examples to use new create_session API 2024-01-30 11:43:22 +02:00
custom_timestamps.cc examples: Add missing includes to examples 2022-09-08 09:38:03 +03:00
receiving_hook.cc examples: Update examples to use the new RCE send/recv only flags 2022-09-06 11:47:09 +03:00
receiving_poll.cc examples: Update examples to use the new RCE send/recv only flags 2022-09-06 11:47:09 +03:00
rtcp_hook.cc examples: Fix zrtp multistream example, add missing iostream includes 2022-08-25 07:58:24 +03:00
sending.cc examples: Add missing includes to examples 2022-09-08 09:38:03 +03:00
sending_generic.cc examples: Update examples to use the new RCE send/recv only flags 2022-09-06 11:47:09 +03:00
srtp_user.cc examples: Add missing includes to examples 2022-09-08 09:38:03 +03:00
srtp_zrtp.cc ci: Fix never-ending example srtp_zrtp and add it to CI-testing 2023-01-30 14:14:17 +02:00
sync_receiver.cc examples: Update examples to use new create_session API 2024-01-30 11:43:22 +02:00
sync_sender.cc examples: Update examples to use new create_session API 2024-01-30 11:43:22 +02:00
v3c_receiver.cc examples: Input V3C test file name as a command-line parameter 2024-01-30 11:43:24 +02:00
v3c_sender.cc examples: Input V3C test file name as a command-line parameter 2024-01-30 11:43:24 +02:00
zrtp_multistream.cc examples: Update examples to use new create_session API 2024-01-30 11:43:22 +02:00

README.md

uvgRTP example codes

This directory contains a collection of commented and functioning examples that demonstrate the usage of uvgRTP.

Building the examples

Compile the library according to instructions in BUILDING.md. Follow either Visual Studio or Linux compilation instructions below:

Visual Studio compilation

Navigate to uvgRTP/build/examples and open the uvgrtp_examples.sln with Visual Studio, through which you can build the individual example programs. When building, select the Release x64 version. The built executable files will be found in uvgRTP/build/examples/Release

Linux and MinGW compilation

Navigate to uvgRTP/build/examples and compile the programs with the make command.

Basic RTP examples

How to create a simple RTP sender (Pair with one of the receiver examples)

How to create a simple RTP receiver (hooking)

NOTE: The hook should not be used for extensive media processing. It is meant to be used as an interface between application and library where uvgRTP hands off the RTP frames to an application thread.

How to create a simple RTP receiver (polling)

Visual Volumetric Video-based Coding (V3C) streaming

To demonstrate V3C streaming, uvgRTP comes with example V3C sender and V3C receiver programs, found in uvgRTP/build/examples. Below are simple step-by-step instructions to run these programs:

  1. Build the library according to instructions in BUILDING.md. Crypto++ is not needed.
  2. Build the v3c_sender and v3c_receiver applications according to building instructions on the top of this page.
  3. Download a test sequence from here.
  4. Place the test sequence in uvgRTP/build/examples/Release
  5. Start the v3c_receiver program with ./v3c_receiver uvgRTP_example_sequence_longdress.vpcc. If you have changed the filename, modify the command accordingly.
  6. Start the v3c_sender program with ./v3c_sender uvgRTP_example_sequence_longdress.vpcc. The program will parse the test sequence for transmission and send it to the receiver.
  7. The with v3c_receiver will print information on the reception and reconstruction of the V3C bitstream.

RTCP example

How to use RTCP instance (hooking)

Encryption examples

Make sure you have checked the build instructions if you want to build the encryption examples with Visual Studio.

How to use SRTP with ZRTP

How to use multi-stream SRTP with ZRTP

How to use SRTP with user-managed keys

Advanced RTP examples

How to modify uvgRTP behavior

How to fragment generic media types

How to enable UDP hole punching

How to use custom timestamps correctly