Lớp: StreamManager

StreamManager

class   public

Xử lý các luồng chèn quảng cáo động. Lớp này quản lý các hoạt động tương tác với phần phụ trợ DAI và xử lý ping theo dõi cũng như chuyển tiếp luồng và 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

new StreamManager(videoElement, adUiElement, uiSettings)

Hàm khởi tạo.

Thông số

videoElement

Phần tử video HTML nơi quá trình phát sẽ diễn ra.

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

adUiElement

Không bắt buộc

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

uiSettings

Không bắt buộc

Chế độ cài đặt giao diện người dùng để sử dụng cho luồng này.

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

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

Thuộc tính

clickElement

HTMLElement không rỗng

clickElement

HTMLElement không rỗng

streamMonitor

PodServingStreamMonitor không rỗng

Phương thức

addEventListener

addEventListener(type, listener) trả về void

Thêm trình nghe cho loại sự kiện đã cho.

Thông số

loại

chuỗi

Loại sự kiện cần nghe.

trình nghe

function(non-null StreamEvent)

Một hàm được gọi mỗi khi một sự kiện thuộc loại này xảy ra.
Giá trị trả về

void 

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) trả về số

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

Thông số

streamTime

số

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 lượng phát trực tuyến đã cho sau khi xoá quảng cáo.

tiêu điểm

focus() trả về void

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

Giá trị trả về

void 

getAdSkippableState

getAdSkippableState() trả về boolean

Trả về true nếu hiện có thể bỏ qua quảng cáo. 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 hiện có thể bỏ qua quảng cáo, sai nếu không.

loadStreamMetadata

loadStreamMetadata() trả về void

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

Giá trị trả về

void 

onTimedMetadata

onTimedMetadata(metadata) trả về void

Truyền vào một từ điển siêu dữ liệu đã xử lý. Từ điển dự kiến khoá "TXXX" có 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 rỗng hoặc không rỗng có thuộc tính chuỗi)

Từ điển siêu dữ liệu.
Giá trị trả về

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

Trả về điểm tín hiệu trước đó cho thời gian phát trực tuyến đã cho. Trả về giá trị rỗng nếu không có điểm tín hiệu nào như vậy. Phương thức này được 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 người dùng đã tua để quay lại điểm chèn quảng cáo.

Thông số

streamTime

số

thời gian phát trực tuyến đã được tua đến.
Giá trị trả về

(null or non-null CuePoint) điểm tín hiệu trước đó cho thời gian phát trực tuyến nhất định.

processMetadata

processMetadata(type, data, timestamp) trả về void

Xử lý siêu dữ liệu được tính giờ 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

chuỗi

Loại siêu dữ liệu. Phải là "ID3" đối với HLS hoặc URI mã nhận dạng giao thức thông báo sự kiện đối với DASH.

khác

(chuỗi hoặc Uint8Array không rỗng)

Dữ liệu thẻ thô. Đối với ID3, 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.

dấu thời gian

số

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

void 

removeEventListener

removeEventListener(type, listener) trả về void

Xoá trình nghe cho loại sự kiện đã cho. Hàm trình nghe phải bằng nhau bằng cách tham chiếu đến hàm đã truyền trước đó đến addEventListener.

Thông số

loại

chuỗi

Loại sự kiện cần xoá trình nghe.

trình nghe

function(non-null StreamEvent)

Hàm cần xoá dưới dạng trình nghe.
Giá trị trả về

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) trả về void

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

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

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

void 

requestStream

requestStream(streamRequest) trả về void

Yêu cầu tải luồng bằng các thông số luồng được cung cấp.

Thông số

streamRequest

StreamRequest

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

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

void 

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

reset() trả về void

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

Giá trị trả về

void 

setClickElement

setClickElement(clickElement) trả về void

Đặt phần tử lượt nhấp vào 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ể khiến người dùng rời khỏi trang hiện tại. Giờ đây, tính năng này không còn được dùng nữa và bạn nên truyền adUiElement vào StreamManager. Nếu bạn cung cấp một adUiElement 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ử rỗng hoặc không rỗng)

Phần tử được dùng làm lượt nhấp vào quảng cáo.
Không được dùng nữa
Cung cấp adUiElement cho hàm khởi tạo StreamManager.
Giá trị trả về

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) trả về số

Trả về thời gian phát trực tuyến có quảng cáo cho một khoảng thời gian nội dung nhất định. Trả về thời lượng nội dung nhất định cho sự kiện phát trực tiếp.

Thông số

contentTime

số

thời lượng nội dung không có quảng cáo (tính bằng giây).
Giá trị trả về

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.