RTCRtpTransceiver: setCodecPreferences() method

Cú pháp

setCodecPreferences(codecs)

Tham số

codecs

Một mảng các đối tượng, mỗi đối tượng cung cấp tham số cho một trong các media codec được transceiver hỗ trợ, được sắp theo mức ưu tiên. Nếu codecs rỗng, toàn bộ cấu hình codec sẽ được đưa về mặc định của user agent.

Note: Bất kỳ codec nào không có trong codecs sẽ không được xem xét trong quá trình thương lượng kết nối. Điều này giúp bạn ngăn việc dùng những codec mà bạn không muốn dùng.

Mỗi đối tượng codec trong mảng có các thuộc tính sau:

channels Optional

Một số nguyên dương cho biết số kênh mà codec hỗ trợ. Ví dụ, với codec âm thanh, giá trị 1 chỉ âm thanh mono, còn 2 chỉ stereo.

clockRate

Một số nguyên dương chỉ định tần số clock của codec theo Hertz (Hz). Tần số clock là tốc độ mà dấu thời gian RTP của codec tăng lên. Hầu hết codec có các giá trị hoặc khoảng giá trị cụ thể mà chúng cho phép. IANA duy trì một danh sách codec và tham số của chúng, bao gồm cả tần số clock.

mimeType

Một chuỗi cho biết kiểu media MIME và subtype của codec, được chỉ định dưới dạng "type/subtype". Chuỗi MIME type dùng bởi RTP khác với những chuỗi dùng ở nơi khác. IANA duy trì một registry các MIME type hợp lệ. Xem thêm Codecs used by WebRTC để biết chi tiết về các codec tiềm năng có thể được tham chiếu ở đây.

sdpFmtpLine Optional

Một chuỗi cho biết trường tham số đặc thù định dạng từ dòng a=fmtp trong SDP tương ứng với codec, nếu trường đó có mặt. Nếu không có trường tham số, thuộc tính này sẽ bị bỏ qua.

Giá trị trả về

Không có (undefined).

Ngoại lệ

InvalidAccessError DOMException

Danh sách codecs bao gồm một hoặc nhiều codec không được RTCRtpReceiver liên quan đến transceiver hỗ trợ.

InvalidModificationError DOMException

Danh sách codecs chỉ chứa các mục cho RTX, RED, FEC hoặc Comfort Noise, hoặc là tập rỗng. Các codec phải luôn chứa một codec cho media.

Ví dụ

Tạo mảng codec ưu tiên

Cách khuyến nghị để đặt ưu tiên codec là trước tiên lấy mảng codec thực sự được hỗ trợ để giải mã dữ liệu nhận, rồi sắp xếp lại danh sách theo thứ tự ưu tiên giảm dần.

Điều quan trọng là bắt đầu từ danh sách codec được hỗ trợ (không phải danh sách codec ưu tiên được hard-code), vì nếu bạn bao gồm bất kỳ codec nào không được RTCRtpReceiver liên quan hỗ trợ, trình duyệt sẽ ném ngoại lệ InvalidAccessError khi bạn gọi phương thức setCodecPreferences(). Ngoài ra, mảng này phải bao gồm các codec phù hợp cho truyền lại, dự phòng, và sửa lỗi tiến tiếp, và việc bắt đầu từ danh sách codec được hỗ trợ sẽ đảm bảo các codec này có mặt.

Bạn có thể lấy các codec được hỗ trợ để giải mã dữ liệu bằng phương thức tĩnh RTCRtpReceiver.getCapabilities() như sau:

const availReceiveCodecs = transceiver.receiver.getCapabilities("video").codecs;

Để sắp xếp lại mảng codec theo thứ tự ưu tiên mong muốn, chúng ta có thể dùng hàm sắp xếp dưới đây để sắp theo MIME type (điều này lấy từ setCodecPreferences is now in all browsers! trên blog.mozilla.org (2024)).

function sortByMimeTypes(codecs, preferredOrder) {
  return codecs.sort((a, b) => {
    const indexA = preferredOrder.indexOf(a.mimeType);
    const indexB = preferredOrder.indexOf(b.mimeType);
    const orderA = indexA >= 0 ? indexA : Number.MAX_VALUE;
    const orderB = indexB >= 0 ? indexB : Number.MAX_VALUE;
    return orderA - orderB;
  });
}

Phương thức nhận danh sách codec được hỗ trợ, và một mảng chứa các MIME type ưu tiên theo thứ tự giảm dần, rồi trả về mảng đã được sắp xếp tại chỗ. Đoạn mã dưới đây cho thấy cách dùng, giả sử bạn đã thiết lập một peer connection (peerConnection):

// Lấy codec được hỗ trợ rồi sắp theo codec ưu tiên
const supportedCodecs = RTCRtpReceiver.getCapabilities("video").codecs;
const preferredCodecs = ["video/H264", "video/VP8", "video/VP9"];
const sortedCodecs = sortByMimeTypes(supportedCodecs, preferredCodecs);

// Lấy transceiver của kết nối và đặt ưu tiên
const [transceiver] = peerConnection.getTransceivers();
transceiver.setCodecPreferences(sortedCodecs); // <---

Tiêu chuẩn

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

Xem thêm

• setCodecPreferences is now in all browsers! on blog.mozilla.org (2024)
• WebRTC API
• Codecs used by WebRTC
• Giới thiệu về Real-time Transport Protocol (RTP)
• Web media technologies