Skip to Content
DocumentationAPI ReferenceTrình phát trực tiếp

Truyền trực tiếp API

Truyền trực tiếp API cung cấp các điểm cuối để tìm kiếm và lấy thông tin về các sự kiện trực tuyến của bạn. Điều này cho phép bạn xây dựng “Hồ sơ trực tuyến” và nhúng người chơi trực tuyến vào ứng dụng của mình.


Lấy Truyền trực tuyến hoạt động

Đây là điểm cuối chính để tìm kiếm các luồng đang được phát trực tuyến. Nó trả về danh sách chỉ những luồng đang nhận tín hiệu từ máy phát mã hóa.

GET /live-streams/active

Parameters

Điểm cuối này không nhận bất kỳ tham số nào. Nó sẽ trả lại tất cả các luồng hoạt động cho tài khoản của bạn.

Ví dụ Yêu cầu

GET /api/client/v1/live-streams/active Host: https://your-app.com Authorization: Bearer sk-your-api-key-here

Trả về: GET /live-streams/active

Nếu các luồng đang hoạt động, bạn sẽ nhận được một mảng của đối tượng LiveStream. trạng thái sẽ là active và một đối tượng manifest sẽ có mặt.

Trả về: 200 OK (Luồng hoạt động)
{ "data": [ { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Tuần Q&A", "description": "Trả lời các câu hỏi của bạn trực tuyến.", "status": "active", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "thể loại": "Tech Talk", "máy chủ": "Jane Doe" }, "tags": ["trực tuyến", "q&a"], "tạo lúc": "2024-08-01T10:00:00Z" } ] }

Nếu không có luồng nào đang hoạt động, điểm cuối sẽ trả về một mảng trống.

Trả về: 200 OK (Không có Luồng hoạt động)
{ "data": [] }

Lấy tất cả Truyền trực tuyến

Điểm cuối này cung cấp một danh mục phân trang của tất cả các luồng trực tuyến được cấu hình trong tài khoản của bạn, bất kể trạng thái hiện tại (hoạt động hoặc không hoạt động). Điều này hữu ích cho việc xây dựng lịch trình hoặc danh sách kênh có sẵn.

GET /live-streams

Parameters

TênLoạiYêu cầuBeschreibung
per_pageintegerOptionalSố lượng luồng trả về trên mỗi trang. Mặc định: 15, Max: 100.

Ví dụ Yêu cầu

GET /api/client/v1/live-streams?per_page=2

Trả về: GET /live-streams

Trả về là danh sách phân trang tiêu chuẩn. trạng thái sẽ là active hoặc inactive, và đối tượng manifest chỉ có mặt cho các luồng hoạt động.

Trả về: 200 OK
{ "data": [ { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Tuần Q&A", "description": "Trả lời các câu hỏi của bạn trực tuyến.", "status": "active", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "thể loại": "Tech Talk" }, "tags": ["trực tuyến", "q&a"], "tạo lúc": "2024-08-01T10:00:00Z" }, { "id": "9c1a9e3e-1a2b-3c4d-5e6f-7g8h9i0j1k2l", "title": "Sự kiện sản phẩm sắp tới", "description": "Tham gia chúng tôi cho sự kiện lớn.", "status": "inactive", "metadata": { "thể loại": "Sản phẩm" }, "tags": ["sự kiện", "trình diễn"], "tạo lúc": "2024-07-25T15:00:00Z" } ], "links": { "first": "https://your-app.com/api/client/v1/live-streams?page=1", "last": "https://your-app.com/api/client/v1/live-streams?page=3", "trước": null, "tiếp theo": "https://your-app.com/api/client/v1/live-streams?page=2" }, "meta": { "trang hiện tại": 1, "từ": 1, "trang cuối cùng": 3, "đường dẫn": "https://your-app.com/api/client/v1/live-streams", "per_page": 2, "đến": 2, "tổng số": 6 } }

Lấy một Truyền trực tuyến

Lấy thông tin chi tiết đầy đủ cho một luồng trực tuyến cụ thể bằng ID của nó. Đây là điểm cuối bạn sẽ gọi để lấy thông tin cần thiết để tải luồng vào người chơi.

GET /live-streams/{streamId}

Path Parameters

TênLoạiBeschreibung
streamIduuidYêu cầu. ID duy nhất của luồng trực tuyến.

Ví dụ Yêu cầu

GET /api/client/v1/live-streams/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f

Trả về: GET /live-streams/{streamId}

Trả về là một đối tượng LiveStream duy nhất. Đối tượng manifest sẽ có mặt nếu luồng đang hoạt động.

Trả về: 200 OK (Luồng đang hoạt động)
{ "data": { "id": "9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f", "title": "Tuần Q&A", "description": "Trả lời các câu hỏi của bạn trực tuyến.", "status": "active", "manifest": { "hls_url": "https://your-app.com/storage/live_media/live/9c1a9e3e-7d8c-5g9b-9f1c-8a2b0c3d9e8f/adaptive/master.m3u8" }, "metadata": { "thể loại": "Tech Talk", "máy chủ": "Jane Doe" }, "tags": ["trực tuyến", "q&a"], "tạo lúc": "2024-08-01T10:00:00Z" } }