update documentation (#295)

This commit is contained in:
Alessandro Ros
2023-05-31 19:30:25 +02:00
committed by GitHub
parent d609d96416
commit b3bf4725b1
6 changed files with 6 additions and 6 deletions

View File

@@ -45,7 +45,7 @@ Features:
* Parse RTSP elements
* Encode/decode format-specific frames into/from RTP packets. The following formats are supported:
* Video: AV1, VP9, VP8, H265, H264, MPEG-4 Video (H263, Xvid), M-JPEG
* Audio: Opus, MPEG-4 Audio (AAC), MPEG-2 Audio (MP3), G722, G711 (PCMA, PCMU), LPCM
* Audio: Opus, MPEG-4 Audio (AAC), MPEG-1/2 Audio (MP3), G722, G711 (PCMA, PCMU), LPCM
## Table of contents

View File

@@ -6,7 +6,7 @@ import (
"github.com/bluenviron/gortsplib/v3/pkg/formats/rtpmpeg2audio"
)
// MPEG2Audio is a RTP format that uses a MPEG-1 or MPEG-2 Audio codec.
// MPEG2Audio is a RTP format that uses a MPEG-1/2 Audio codec.
// Specification: https://datatracker.ietf.org/doc/html/rfc2250
type MPEG2Audio struct{}

View File

@@ -4,7 +4,7 @@ import (
"github.com/pion/rtp"
)
// MPEG2Video is a RTP format that uses a MPEG-1 or MPEG-2 Video codec.
// MPEG2Video is a RTP format that uses a MPEG-1/2 Video codec.
// Specification: https://datatracker.ietf.org/doc/html/rfc2250
type MPEG2Video struct{}

View File

@@ -30,7 +30,7 @@ func joinFragments(fragments [][]byte, size int) []byte {
return ret
}
// Decoder is a RTP/MPEG-2 Audio decoder.
// Decoder is a RTP/MPEG-1/2 Audio decoder.
// Specification: https://datatracker.ietf.org/doc/html/rfc2250
type Decoder struct {
timeDecoder *rtptime.Decoder

View File

@@ -28,7 +28,7 @@ func lenAggregated(frames [][]byte, frame []byte) int {
return l
}
// Encoder is a RTP/MPEG-2 Audio encoder.
// Encoder is a RTP/MPEG-1/2 Audio encoder.
// Specification: https://datatracker.ietf.org/doc/html/rfc2250
type Encoder struct {
// SSRC of packets (optional).

View File

@@ -1,2 +1,2 @@
// Package rtpmpeg2audio contains a RTP/MPEG-2 Audio decoder and encoder.
// Package rtpmpeg2audio contains a RTP/MPEG-1/2 Audio decoder and encoder.
package rtpmpeg2audio