RTCRtpScriptTransformer: phương thức generateKeyFrame()

Cú pháp

generateKeyFrame()
generateKeyFrame(rid)

Tham số

rid Optional

Một chuỗi chứa "restriction identifier" ("RID") của stream/bộ mã hóa phải tạo khung chính mới.

Giá trị phải có từ 1 đến 255 ký tự (bao gồm), và chỉ chứa các ký tự chữ số, dấu gạch dưới, và dấu gạch ngang (A-Z, a-z, 0-9, -, _). RID phân biệt chữ hoa chữ thường và phải là duy nhất cho kênh giao tiếp peer.

Bộ mã hóa đầu tiên khớp với rid được chỉ định được sử dụng. Nếu không có bộ mã hóa nào khớp với rid thì bộ mã hóa đầu tiên được sử dụng, và rid được đặt theo các hạn chế của bộ mã hóa.

Giá trị trả về

Một Promise được giải quyết với timestamp của khung, hoặc bị từ chối với một giá trị ngoại lệ.

Ngoại lệ

InvalidStateError

Bộ mã hóa không xử lý các khung video, hoặc là undefined.

TypeError

rid được cung cấp nhưng không tuân thủ các yêu cầu ngữ pháp.

NotFoundError

Không có bộ mã hóa video nào. Điều này có thể được ném ra nếu RTCRtpSender tương ứng không hoạt động hoặc track của nó đã kết thúc.

Mô tả

Phương thức này có thể được gọi bởi một transformer đang xử lý các khung video được mã hóa đi để buộc gửi một khung hoàn chỉnh (khung chính) mới. Điều này có thể cần thiết bởi một WebRTC Encoded Transform mã hóa các khung, để đảm bảo rằng nếu một khóa mã hóa mới được thêm vào, một khung chính được mã hóa bằng khóa đó được gửi càng sớm càng tốt.

Người gửi có thể chỉ định một RID (còn được gọi là "restriction identifier" hoặc "RTP stream ID") để kiểm soát codec nào tạo ra khung chính mới. Một stream có thể chứa (simulcast) nhiều phiên bản của cùng một nguồn, mỗi phiên bản với các thuộc tính khác nhau như độ phân giải và tốc độ khung. RID được sử dụng để chỉ một luồng RTP cụ thể, và do đó là bộ mã hóa cần tạo khung mới. Lưu ý rằng các giá trị RID có sẵn được đặt khi transceiver được sử dụng bởi kết nối được tạo. Các giá trị RID đang được sử dụng có thể được truy vấn bằng cách gọi RTCRtpSender.getParameters() và kiểm tra thuộc tính encodings của giá trị được trả về.

Promise được trả về bởi phương thức sẽ được giải quyết ngay trước khi xếp hàng đợi khung chính tương ứng trong RTCRtpScriptTransformer readable.

Ví dụ

Gửi khung chính

Ví dụ bên dưới cho thấy cách luồng chính có thể truyền khóa mã hóa đến transform gửi, và kích hoạt codec tạo khung chính.

Lưu ý rằng luồng chính không có quyền truy cập trực tiếp vào đối tượng RTCRtpScriptTransformer, vì vậy nó cần truyền khóa và RID đến worker. Ở đây chúng ta thực hiện điều đó với một MessageChannel, transfer cổng thứ hai đến mã transformer chạy trong worker. Mã giả định đã có một peer connection, và videoSender là một RTCRtpSender.

const worker = new Worker("worker.js");
const channel = new MessageChannel();

videoSender.transform = new RTCRtpScriptTransform(
  worker,
  { name: "senderTransform", port: channel.port2 },
  [channel.port2],
);

// Post RID and new key to the sender
channel.port1.start();
channel.port1.postMessage({
  rid: "1",
  key: "93ae0927a4f8e527f1gce6d10bc6ab6c",
});

Trình xử lý sự kiện rtctransform trong worker lấy cổng và sử dụng nó để lắng nghe các sự kiện message. Nếu nhận được sự kiện, nó lấy rid và key, sau đó gọi generateKeyFrame().

event.transformer.options.port.onmessage = (event) => {
  const { rid, key } = event.data;
  // key is used by the transformer to encrypt frames (not shown)

  // Get codec to generate a new key frame using the rid
  // Here 'rcEvent' is the rtctransform event.
  rcEvent.transformer.generateKeyFrame(rid);
};

Thông số kỹ thuật

Tương thích trình duyệt

Xem thêm

• Using WebRTC Encoded Transforms