chunk

Documentation

Overview

Package chunk implements RTMP chunks.

Index

• type Chunk
• type Chunk0
  • func (c Chunk0) Marshal(_ bool) ([]byte, error)
  • func (c *Chunk0) Read(r io.Reader, maxBodyLen uint32, _ bool) error
• type Chunk1
  • func (c Chunk1) Marshal(_ bool) ([]byte, error)
  • func (c *Chunk1) Read(r io.Reader, maxBodyLen uint32, _ bool) error
• type Chunk2
  • func (c Chunk2) Marshal(_ bool) ([]byte, error)
  • func (c *Chunk2) Read(r io.Reader, bodyLen uint32, _ bool) error
• type Chunk3
  • func (c Chunk3) Marshal(hasExtendedTimestamp bool) ([]byte, error)
  • func (c *Chunk3) Read(r io.Reader, bodyLen uint32, hasExtendedTimestamp bool) error

Types

type Chunk

type Chunk interface {
	Read(r io.Reader, bodyLen uint32, hasExtendedTimestamp bool) error
	Marshal(hasExtendedTimestamp bool) ([]byte, error)
}

Chunk is a chunk.

type Chunk0

type Chunk0 struct {
	ChunkStreamID   byte
	Timestamp       uint32
	BodyLen         uint32
	Type            uint8
	MessageStreamID uint32
	Body            []byte
}

Chunk0 is a type 0 chunk. This type MUST be used at the start of a chunk stream, and whenever the stream timestamp goes backward (e.g., because of a backward seek).

func (Chunk0) Marshal

func (c Chunk0) Marshal(_ bool) ([]byte, error)

Marshal writes the chunk.

func (*Chunk0) Read

func (c *Chunk0) Read(r io.Reader, maxBodyLen uint32, _ bool) error

Read reads the chunk.

type Chunk1

type Chunk1 struct {
	ChunkStreamID  byte
	TimestampDelta uint32
	BodyLen        uint32
	Type           uint8
	Body           []byte
}

Chunk1 is a type 1 chunk. The message stream ID is not included; this chunk takes the same stream ID as the preceding chunk. Streams with variable-sized messages (for example, many video formats) SHOULD use this format for the first chunk of each new message after the first.

func (Chunk1) Marshal

func (c Chunk1) Marshal(_ bool) ([]byte, error)

Marshal writes the chunk.

func (*Chunk1) Read

func (c *Chunk1) Read(r io.Reader, maxBodyLen uint32, _ bool) error

Read reads the chunk.

type Chunk2

type Chunk2 struct {
	ChunkStreamID  byte
	TimestampDelta uint32
	Body           []byte
}

Chunk2 is a type 2 chunk. Neither the stream ID nor the message length is included; this chunk has the same stream ID and message length as the preceding chunk.

func (Chunk2) Marshal

func (c Chunk2) Marshal(_ bool) ([]byte, error)

Marshal writes the chunk.

func (*Chunk2) Read

func (c *Chunk2) Read(r io.Reader, bodyLen uint32, _ bool) error

Read reads the chunk.

type Chunk3

type Chunk3 struct {
	ChunkStreamID byte
	Body          []byte
}

Chunk3 is a type 3 chunk. Type 3 chunks have no message header. The stream ID, message length and timestamp delta fields are not present; chunks of this type take values from the preceding chunk for the same Chunk Stream ID. When a single message is split into chunks, all chunks of a message except the first one SHOULD use this type.

func (Chunk3) Marshal

func (c Chunk3) Marshal(hasExtendedTimestamp bool) ([]byte, error)

Marshal writes the chunk.

func (*Chunk3) Read

func (c *Chunk3) Read(r io.Reader, bodyLen uint32, hasExtendedTimestamp bool) error

Read reads the chunk.