Lớp: StreamManager

Hàm dựng

StreamManager

mới StreamManager(videoElement, adUiElement, uiSettings)

Thông số

videoElement

Phần tử video HTML nơi sẽ phát video.

Giá trị không được rỗng.

adUiElement

Không bắt buộc

Phần tử HTML cần sử dụng để giữ các phần tử trên giao diện người dùng của quảng cáo. Phần tử này phải có cùng chiều cao và chiều rộng với phần phát video và nên phủ trực tiếp lên trên. Nếu bạn không cung cấp thuộc tính này, thì hệ thống sẽ không hiển thị giao diện người dùng và không có quảng cáo nào yêu cầu giao diện người dùng (chẳng hạn như quảng cáo có thể bỏ qua).

Giá trị không được rỗng.

uiSettings

Không bắt buộc

Chế độ cài đặt giao diện người dùng để sử dụng cho sự kiện phát trực tiếp này.

Giá trị không được rỗng.

Triển khai
EventTarget
Gửi

khi tham số đầu vào không đáp ứng yêu cầu.

Phương thức

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) trả về số

Trả về thời gian nội dung không có quảng cáo cho một thời gian phát trực tiếp nhất định. Trả về thời lượng phát trực tiếp cụ thể.

Thông số

streamTime

number

thời gian phát trực tiếp có quảng cáo được chèn (tính bằng giây).

Trả bóng

number thời gian nội dung tương ứng với thời điểm phát trực tiếp nhất định sau khi quảng cáo bị xóa.

tiêu điểm

tiêu điểm()

Tập trung vào nút bỏ qua, nếu có. Nếu không có, thì tiêu điểm sẽ được đặt vào các phần tử tương tác, bao gồm cả biểu tượng hoặc mẫu quảng cáo tương tác.

getAdSkippableState

getAdSkipState() trả về boolean

Trả về true nếu quảng cáo hiện có thể bỏ qua. Khi giá trị này thay đổi, StreamManager sẽ kích hoạt sự kiện StreamEvent.SKIPPABLE_STATE_CHANGED.

Trả bóng

boolean True nếu quảng cáo hiện có thể bỏ qua, nếu không thì "false".

loadStreamMetadata

loadStreamMetadata()

Yêu cầu SDK để tải siêu dữ liệu quảng cáo, sau đó phát StreamEvent.LOADED. Bạn nên kích hoạt thao tác này theo cách thủ công sau khi tệp kê khai luồng được truy xuất từ công cụ kết hợp video của bên thứ ba. Tính năng này chỉ được dùng cho VOD phân phát nhóm bằng công cụ kết hợp video của bên thứ ba và không hoạt động cho các yêu cầu phát trực tiếp khác.

onTimedMetadata

onTimedMetadata(metadata)

Chuyển vào từ điển của siêu dữ liệu đã xử lý. Từ điển yêu cầu khoá "TXXX" với chuỗi siêu dữ liệu do người dùng xác định làm giá trị. Nếu trình phát của bạn cung cấp siêu dữ liệu thô, hãy gọi StreamManager.processMetadata.

Thông số

siêu dữ liệu

Đối tượng

Từ điển về siêu dữ liệu.

Giá trị không được rỗng.

previousCuePointForStreamTime

beforeCuePointForStreamTime(streamTime) trả về CuePoint

Trả về điểm dừng trước đó cho thời gian phát trực tiếp đã cho. Trả về giá trị rỗng nếu không tồn tại điểm dừng nào như vậy. Lệnh này dùng để triển khai các tính năng như quay lại nhanh và được gọi khi nhà xuất bản phát hiện thấy người dùng đã tìm kiếm để đưa người dùng trở lại một điểm chèn quảng cáo.

Thông số

streamTime

number

thời gian phát trực tiếp mong muốn.

Trả bóng

nullable CuePoint điểm dừng trước đó cho thời gian phát trực tiếp cụ thể.

processMetadata

processMetadata(type, data, timestamp)

Xử lý siêu dữ liệu đã xác định thời gian cho sự kiện phát trực tiếp. Sử dụng nếu trình phát video của bạn cung cấp siêu dữ liệu chưa được phân tích cú pháp cùng với dấu thời gian. Nếu không, hãy gọi StreamManager.onTimedMetadata.

Thông số

loại

string

Loại cho siêu dữ liệu. Phải là "ID3" cho HLS hoặc là URI ID lược đồ thông báo sự kiện cho DASH.

data

(Uint8Array hoặc chuỗi không có giá trị null)

Dữ liệu thô của thẻ. Đối với Mã nhận dạng 3, phải là toàn bộ dữ liệu thẻ thô. Đối với thông báo sự kiện DASH, đây là chuỗi dữ liệu thông báo.

timestamp

number

Thời gian tính bằng giây khi dữ liệu cần được xử lý. Đối với DASH, đây là thời gian bắt đầu thông báo sự kiện.

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

Thay thế tất cả thông số thẻ quảng cáo được dùng cho các yêu cầu quảng cáo sắp tới trong sự kiện phát trực tiếp.

Thông số

adTagParameters

Đối tượng có thuộc tính chuỗi

Thông số thẻ quảng cáo mới. Phải có giá trị chuỗi.

Giá trị không được rỗng.

requestStream

requestStream(streamRequest)

Yêu cầu tải luồng bằng các tham số luồng đã cung cấp.

Thông số

streamRequest

StreamRequest

chứa các tham số để tải siêu dữ liệu của luồng.

Giá trị không được rỗng.

Khôi phục tuỳ chọn tìm kiếm

đặt lại()

Đặt lại trình quản lý luồng và xoá mọi cuộc thăm dò liên tục.

setClickElement

setClickElement(clickElement)

Thiết lập phần tử nhấp qua quảng cáo. Phần tử này được dùng làm trình nhận lượt nhấp hoặc nhấn trong khi quảng cáo đang phát và có thể dẫn đến việc điều hướng ra khỏi trang hiện tại. Tính năng này hiện không được dùng nữa và thay vào đó, bạn nên truyền adUiElement vào StreamManager. Nếu một adUiElement được cấp cho hàm khởi tạo StreamManager, thì phương thức này sẽ không hoạt động.

Thông số

clickElement

Phần tử

Thành phần được dùng làm lượt nhấp vào quảng cáo.

Giá trị có thể rỗng.

Không được dùng nữa
Thay vào đó, hãy cung cấp một adUiElement cho hàm khởi tạo StreamManager.

streamTimeForContentTime

streamTimeForContentTime(contentTime) trả về số

Trả về thời gian phát trực tiếp có quảng cáo cho một thời điểm nội dung nhất định. Trả về thời gian nội dung cụ thể của chương trình phát trực tiếp.

Thông số

contentTime

number

thời gian nội dung không có quảng cáo (tính bằng giây).

Trả bóng

number thời gian phát trực tuyến tương ứng với thời gian nội dung nhất định sau khi chèn quảng cáo.