Xử lý luồng chèn quảng cáo động. Lớp này quản lý các lượt tương tác với máy chủ DAI, xử lý các ping theo dõi và phát ra các sự kiện về luồng phát và quảng cáo.
| Hàm khởi tạo | |
|---|---|
constructor
|
|
| Phương thức | |
|---|---|
add
|
Thêm một trình nghe cho loại sự kiện đã cho. |
content
|
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 tuyến nhất định. |
focus
|
Đặt tiêu điểm vào nút bỏ qua (nếu có). |
get
|
Trả về giá trị
true nếu người dùng có thể bỏ qua quảng cáo hiện tại. |
load
|
Yêu cầu DAI SDK tải siêu dữ liệu quảng cáo và phát ra một sự kiện luồng
LOADED.
|
on
|
Truyền vào một từ điển siêu dữ liệu đã xử lý. |
previous
|
Trả về điểm đánh dấu trước đó cho thời gian phát trực tiếp đã cho. |
process
|
Xử lý siêu dữ liệu có dấu thời gian cho các luồng. |
remove
|
Xoá một trình nghe cho loại sự kiện StreamEvent đã cho.
|
replace
|
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.
|
request
|
Yêu cầu một luồng DAI của IMA tải bằng cách sử dụng các thông số luồng được cung cấp.
|
reset
|
Đặt lại trình quản lý luồng và xoá mọi hoạt động thăm dò liên tục. |
stream
|
Trả về tổng thời gian phát trực tuyến có quảng cáo cho một thời gian nội dung nhất định. |
Hàm khởi tạo
constructor
new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
| Thông số | |
|---|---|
videoElement: HTMLVideoElement
|
Phần tử video HTML nơi diễn ra quá trình phát. |
|
Phần tử nơi giao diện người dùng quảng cáo hiển thị. |
|
Chế độ cài đặt giao diện người dùng để sử dụng cho luồng này. |
| Giá trị trả về | |
|---|---|
StreamManager
|
|
Phương thức
addEventListener
addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
Thêm một trình nghe cho loại sự kiện đã cho.
| Thông số | |
|---|---|
type:
Type | Type[]
|
Loại sự kiện quảng cáo hoặc một mảng các loại sự kiện. |
listener: ((event: StreamEvent) => void)
|
Một hàm callback cho trình nghe quảng cáo. |
contentTimeForStreamTime
contentTimeForStreamTime(streamTime: number): number
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 tuyến nhất định. Trả về thời gian phát trực tiếp đã cho của sự kiện phát trực tiếp.
| Thông số | |
|---|---|
streamTime: number
|
thời gian phát trực tuyến tính bằng giây, kết hợp nội dung và quảng cáo. |
| Giá trị trả về | |
|---|---|
number
|
thời gian nội dung cho thời gian phát trực tuyến đã cho, không bao gồm quảng cáo. |
focus
focus(): 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 lại trên phần tử tương tác.
getAdSkippableState
getAdSkippableState(): boolean
Trả về giá trị
true nếu người dùng có thể bỏ qua quảng cáo hiện tại. Khi giá trị này thay đổi, lớp StreamManager sẽ phát ra một sự kiện luồng SKIPPABLE_STATE_CHANGED.
| Giá trị trả về | |
|---|---|
boolean
|
true nếu người dùng có thể bỏ qua quảng cáo hiện tại, false nếu không.
|
loadStreamMetadata
loadStreamMetadata(): void
Yêu cầu DAI SDK tải siêu dữ liệu quảng cáo và phát ra sự kiện luồng
LOADED.
Gọi phương thức này theo cách thủ công khi bạn truy xuất tệp kê khai luồng từ trình ghép video bên thứ ba. Phương thức này chỉ dành cho luồng VOD phân phát nhóm có trình ghép video của bên thứ ba.
onTimedMetadata
onTimedMetadata(metadata: {
[key: string]: string;
}): void
Truyền vào một từ điển siêu dữ liệu đã xử lý. Từ điển này mong đợi khoá chính xác
"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 phương thức StreamManager.processMetadata.
| Thông số | |
|---|---|
metadata: {
|
Từ điển siêu dữ liệu. |
previousCuePointForStreamTime
previousCuePointForStreamTime(streamTime: number): CuePoint
Trả về điểm đánh dấu trước đó cho thời gian phát trực tiếp đã cho. Nếu không có điểm đánh dấu nào trước đó, hãy trả về
null. Sử dụng phương thức này để triển khai các tính năng như tua lại bằng cách gọi phương thức khi người dùng tìm cách đưa người dùng trở lại một khoảng thời gian chèn quảng cáo.
| Thông số | |
|---|---|
streamTime: number
|
thời gian phát trực tiếp mà người dùng muốn chuyển đến. |
| Giá trị trả về | |
|---|---|
CuePoint
|
điểm đánh dấu trước đó cho thời gian phát trực tiếp đã cho. |
processMetadata
processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
Xử lý siêu dữ liệu có dấu thời gian cho các luồng. Hãy sử dụng phương thức này 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 kèm dấu thời gian. Nếu không, hãy gọi StreamManager.onTimedMetadata.
| Thông số | |
|---|---|
type: string
|
Loại siêu dữ liệu. Phải là chuỗi 'ID3' cho HLS hoặc URI mã nhận dạng lược đồ thông báo sự kiện cho DASH.
|
data: string | Uint8Array
|
Dữ liệu thô của thẻ. Đối với ID3, phải là toàn bộ dữ liệu thô của 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) để xử lý dữ liệu. Đối với DASH, tham số này là thời gian bắt đầu thông báo sự kiện. |
removeEventListener
removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
Xoá một trình nghe cho loại sự kiện StreamEvent đã cho. Để xoá thành công một trình nghe, tham số trình nghe mà bạn truyền vào phương thức này phải bằng tham chiếu với tham số đã truyền trước đó vào phương thức
addEventListener.
| Thông số | |
|---|---|
type:
Type
|
Loại sự kiện cần xoá trình nghe. |
listener: ((event: StreamEvent) => void)
|
Hàm cần xoá dưới dạng trình nghe. |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters: {
[key:
string]: string;
}): 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: {
|
Các thông số thẻ quảng cáo thay thế. Phải có giá trị chuỗi. |
requestStream
requestStream(streamRequest: StreamRequest): void
Yêu cầu một luồng DAI của IMA tải bằng cách sử dụ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 của luồng phát. |
đặt lại
reset(): void
Đặt lại trình quản lý luồng và xoá mọi hoạt động thăm dò liên tục.
streamTimeForContentTime
streamTimeForContentTime(contentTime: number): number
Trả về tổng thời gian phát trực tuyến có quảng cáo cho một thời gian nội dung nhất định. Trả về thời gian nội dung đã cho cho sự kiện 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. |
| Giá trị trả về | |
|---|---|
number
|
tổng thời gian phát trực tuyến tương ứng với thời gian nội dung đã cho sau khi DAI chèn quảng cáo. |