uvgrtp-base/examples/README.md

# uvgRTP example codes

This directory contains a collection of simple examples that demonstrate how to use uvgRTP

## Available examples

We provide several simple and thoroughly commented examples on how to use uvgRTP.

[How to create a simple RTP sender](sending.cc)

[How to use fragmented input with uvgRTP \(HEVC slices\)](sending_fragmented.cc)

[How to fragment generic media types](sending_generic.cc)

[How to configure uvgRTP to send high-quality video](configuration.cc)

[How to create a simple RTP receiver (hooking)](receiving_hook.cc)

NOTE: The hook should **not** be used for media processing. It should be rather used as interface between application and library where the frame handout happens.

[How to create a simple RTP receiver (polling)](receiving_poll.cc)

[How to create an RTCP instance (polling)](rtcp_poll.cc)

[How to create an RTCP instance (hoooking)](rtcp_hook.cc)

[How to use SRTP with ZRTP](srtp_zrtp.cc)

[How to use SRTP with user-managed keys](srtp_user.cc)

### Memory ownership/deallocation

If you have not enabled the system call dispatcher, you don't need to worry about these

[Method 1, unique_ptr](deallocation_1.cc)

[Method 2, copying](deallocation_2.cc)

[Method 3, deallocation hook](deallocation_3.cc)
Rename kvzRTP to uvgRTP 2020-04-27 11:07:24 +00:00			`# uvgRTP example codes`
Create new folder structure for examples 2019-06-03 08:45:11 +00:00
Update examples directory 2020-05-28 06:50:26 +00:00			`This directory contains a collection of simple examples that demonstrate how to use uvgRTP`
Add instructions for running the example codes Using kvzRTP is far from easy on Windows so something must be done about it at some point. Maybe QtCreator's/Visual Studio's deploy tools could be used to help the installation procedure 2020-04-16 10:24:08 +00:00
			`## Available examples`

Rename kvzRTP to uvgRTP 2020-04-27 11:07:24 +00:00			`We provide several simple and thoroughly commented examples on how to use uvgRTP.`
Add example code for sending Opus 2019-05-15 06:46:48 +00:00
Simplify the structure of example directory Only include code relevant to usage of kvzRTP and put everything in the same directory 2020-04-06 09:02:57 +00:00			`[How to create a simple RTP sender](sending.cc)`

Rename kvzRTP to uvgRTP 2020-04-27 11:07:24 +00:00			`[How to use fragmented input with uvgRTP \(HEVC slices\)](sending_fragmented.cc)`
Simplify the structure of example directory Only include code relevant to usage of kvzRTP and put everything in the same directory 2020-04-06 09:02:57 +00:00
Add example code for generic fragmentation 2020-04-24 18:24:53 +00:00			`[How to fragment generic media types](sending_generic.cc)`

Add example code for context configuration 2020-04-28 06:05:51 +00:00			`[How to configure uvgRTP to send high-quality video](configuration.cc)`

Simplify the structure of example directory Only include code relevant to usage of kvzRTP and put everything in the same directory 2020-04-06 09:02:57 +00:00			`[How to create a simple RTP receiver (hooking)](receiving_hook.cc)`

			`NOTE: The hook should not be used for media processing. It should be rather used as interface between application and library where the frame handout happens.`

			`[How to create a simple RTP receiver (polling)](receiving_poll.cc)`

			`[How to create an RTCP instance (polling)](rtcp_poll.cc)`

			`[How to create an RTCP instance (hoooking)](rtcp_hook.cc)`

Update examples directory 2020-05-28 06:50:26 +00:00			`[How to use SRTP with ZRTP](srtp_zrtp.cc)`

			`[How to use SRTP with user-managed keys](srtp_user.cc)`

Simplify the structure of example directory Only include code relevant to usage of kvzRTP and put everything in the same directory 2020-04-06 09:02:57 +00:00			`### Memory ownership/deallocation`

			`If you have not enabled the system call dispatcher, you don't need to worry about these`

			`[Method 1, unique_ptr](deallocation_1.cc)`

			`[Method 2, copying](deallocation_2.cc)`

			`[Method 3, deallocation hook](deallocation_3.cc)`