Lớp: StreamManager

StreamManager

lớp

Xử lý luồng chèn quảng cáo động. Nền tảng này quản lý các lượt tương tác với phần phụ trợ DAI và xử lý các ping theo dõi cũng như chuyển tiếp luồng và các sự kiện quảng cáo đến nhà xuất bản. Trình quản lý này không kế thừa từ BaseAdsManager vì đây không phải là trình quản lý cho một quảng cáo cụ thể, mà là trình quản lý cho toàn bộ luồng

Hàm dựng

StreamManager

mới StreamManager(videoElement; adUiElement; uiSettings)

Thông số
videoElement	Phần tử video HTML nơi hoạt động phát sẽ diễn ra. Giá trị không được để trống.
adUiElement	Không bắt buộc Phần tử HTML cần sử dụng để chứa 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à phải phủ trực tiếp lên phần tử này. Nếu bạn không cung cấp thì sẽ không có giao diện người dùng nào hiển thị và sẽ 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 để trố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 để trống.

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 trong một khoảng thời gian phát trực tiếp nhất định. Trả về thời lượng phát trực tiếp nhất định.

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).

Giá trị trả về

number thời lượng nội dung tương ứng với thời gian phát trực tiếp nhất định sau khi bạn gỡ bỏ quảng cáo.

tiêu điểm

tiêu điểm()

Đặt tiêu điểm vào nút bỏ qua, nếu có. Nếu không, hệ thống sẽ tập trung 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ị bỏ qua. Khi giá trị này thay đổi, StreamManager sẽ kích hoạt sự kiện StreamEvent.SKIPPABLE_STATE_CHANGED.

Giá trị trả về

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

loadStreamMetadata

loadStreamMetadata()

Yêu cầu SDK tải siêu dữ liệu quảng cáo, sau đó truyền StreamEvent.ytcED. 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ụ ghép video của bên thứ ba. Tính năng này chỉ dùng cho VOD phân phát nhóm với công cụ kết hợp video của bên thứ ba và không dùng được cho yêu cầu luồng khác.

onTimedMetadata

onTimedMetadata(metadata)

Thẻ và vé trong từ điển siêu dữ liệu đã xử lý. Từ điển yêu cầu khoá 'TXXX' với giá trị là chuỗi siêu dữ liệu do người dùng xác định. 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 của siêu dữ liệu. Giá trị không được để trố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 nhất định. Trả về giá trị rỗng nếu không tồn tại điểm dừng như vậy. Lệnh này được dùng để triển khai các tính năng như quay lại và được gọi khi nhà xuất bản phát hiện thấy người dùng đã tìm để đưa người dùng trở lại đ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.

Giá trị trả về

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

processMetadata

processMetadata(type, data, timestamp)

Xử lý siêu dữ liệu theo 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 Nhập siêu dữ liệu. Phải là "ID3" cho HLS hoặc URI mã nhận dạng lược đồ thông báo sự kiện cho DASH.
data	(Uint8Array hoặc chuỗi không rỗng) Dữ liệu thô về thẻ. Đối với ID3, dữ liệu này phải là toàn bộ dữ liệu thẻ thô. Đối với các 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 mà 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ả cá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 một 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 để trống.

requestStream

requestStream(streamRequest)

Yêu cầu một luồng được tải bằng cách sử dụ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 dữ liệu. Giá trị không được để trố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)

Đặt phần tử lượt nhấp vào quảng cáo. Phần tử này được dùng làm nút nhận lượt nhấp hoặc nút nhấn khi quảng cáo đang phát và có thể khiến người dùng rời khỏi trang hiện tại. Tính năng này hiện không còn được dùng nữa và thay vào đó, một adUiElement phải được chuyển 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ẽ trở thành không hoạt động.

Thông số
clickElement	Phần tử Phần tử được sử dụng khi nhấp qua quảng cáo. Giá trị có thể là rỗng.

Không được tán thành

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 trong một khoảng thời gian nội dung cụ thể. Trả về thời lượng nội dung đã cho cho các sự kiện phát trực tiếp.

Thông số
contentTime	number thời gian nội dung không có bất kỳ quảng cáo nào (tính bằng giây).

Giá trị trả về

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