rename 'read' into 'play', 'publish' into 'record' (#463)

examples/client-record-options/main.go

@@ -0,0 +1,88 @@
+package main
+
+import (
+	"log"
+	"net"
+	"time"
+
+	"github.com/bluenviron/gortsplib/v4"
+	"github.com/bluenviron/gortsplib/v4/pkg/description"
+	"github.com/bluenviron/gortsplib/v4/pkg/format"
+	"github.com/pion/rtp"
+)
+
+// This example shows how to
+// 1. set additional client options
+// 2. generate RTP/H264 frames from a file with GStreamer
+// 3. connect to a RTSP server, announce an H264 media
+// 4. write the frames to the server
+
+func main() {
+	// open a listener to receive RTP/H264 frames
+	pc, err := net.ListenPacket("udp", "localhost:9000")
+	if err != nil {
+		panic(err)
+	}
+	defer pc.Close()
+
+	log.Println("Waiting for a RTP/H264 stream on port 9000 - you can send one with GStreamer:\n" +
+		"gst-launch-1.0 filesrc location=video.mp4 ! qtdemux ! video/x-h264" +
+		" ! h264parse config-interval=1 ! rtph264pay ! udpsink host=127.0.0.1 port=9000")
+
+	// wait for first packet
+	buf := make([]byte, 2048)
+	n, _, err := pc.ReadFrom(buf)
+	if err != nil {
+		panic(err)
+	}
+	log.Println("stream connected")
+
+	// create a stream description that contains a H264 format
+	desc := &description.Session{
+		Medias: []*description.Media{{
+			Type: description.MediaTypeVideo,
+			Formats: []format.Format{&format.H264{
+				PayloadTyp:        96,
+				PacketizationMode: 1,
+			}},
+		}},
+	}
+
+	// Client allows to set additional client options
+	c := &gortsplib.Client{
+		// transport protocol (UDP or TCP). If nil, it is chosen automatically
+		Transport: nil,
+		// timeout of read operations
+		ReadTimeout: 10 * time.Second,
+		// timeout of write operations
+		WriteTimeout: 10 * time.Second,
+	}
+
+	// connect to the server and start recording
+	err = c.StartRecording("rtsp://localhost:8554/mystream", desc)
+	if err != nil {
+		panic(err)
+	}
+	defer c.Close()
+
+	var pkt rtp.Packet
+	for {
+		// parse RTP packet
+		err = pkt.Unmarshal(buf[:n])
+		if err != nil {
+			panic(err)
+		}
+
+		// route RTP packet to the server
+		err = c.WritePacketRTP(desc.Medias[0], &pkt)
+		if err != nil {
+			panic(err)
+		}
+
+		// read another RTP packet from source
+		n, _, err = pc.ReadFrom(buf)
+		if err != nil {
+			panic(err)
+		}
+	}
+}