SDK IMA DAI cho Roku

    1. ima
    2. ima.AdBreakInfo
    3. ima.AdEvent
    4. ima.AdInfo
    5. ima.Companion
    6. ima.CuePoint
    7. ima.Error
    8. ima.ErrorEvent
    9. ima.Player
    10. ima.StreamFormat
    11. ima.StreamInfo
    12. ima.StreamManager
    13. ima.StreamRequest
    14. ima.StreamType
    15. ima.WrapperInfo

Lớp ima

Phương thức

Các hàm chung kiểm soát SDK IMA.

disableLogging()

Tắt tính năng ghi nhật ký SDK. Tính năng ghi nhật ký sẽ bật theo mặc định.

getStreamManager()

Trả về một trình quản lý luồng nếu có. Nếu trình quản lý luồng phát chưa có sẵn, hệ thống sẽ trả về Invalid. Nếu xảy ra lỗi khi tạo trình quản lý luồng, thì một đối tượng lỗi sẽ được trả về.

Trả về object: Trình quản lý luồng hoặc đối tượng lỗi.

initSdk(settings)

Khởi chạy SDK.

Thông số Loại Mô tả
settings object

Đối tượng chế độ cài đặt IMA không bắt buộc.

requestStream(streamRequest)

Bắt đầu một yêu cầu phát trực tiếp không đồng bộ. Lệnh điều khiển sẽ ngay lập tức quay lại trình phát sau khi gọi phương thức này.

Trả về object: lỗi hoặc không hợp lệ nếu không có lỗi

Thông số Loại Mô tả
streamRequest object

Quay lại đầu trang

Lớp ima.AdBreakInfo

Trường

Phương thức

Chứa thông tin về một điểm chèn quảng cáo. Được SDK truyền đến các lệnh gọi lại sự kiện.

Thuộc tính

Tên Loại Mô tả
adPosition

Chỉ mục của quảng cáo trong điểm chèn quảng cáo. Chỉ mục này là 1 cho quảng cáo độc lập.

duration

Thời lượng tối đa của khoảng thời gian này (tính bằng giây) hoặc -1 nếu không xác định được.

podIndex

Đối với sự kiện phát trực tiếp, trả về mã nhận dạng điểm chèn dưới dạng chỉ mục nhóm hoặc 0 cho quảng cáo phát trước video. Không có quảng cáo sau video trong sự kiện phát trực tiếp. Giá trị mặc định là -2. Đối với video theo yêu cầu (VOD), trả về chỉ mục của nhóm quảng cáo. Đối với nhóm quảng cáo trong phần đầu video, hãy trả về 0. Đối với quảng cáo trong video, hãy trả về 1, 2, ..., n. Đối với một nhóm quảng cáo cuối video, hàm này trả về n+1...n+x. Mặc định là 0 nếu quảng cáo này không thuộc một nhóm quảng cáo hoặc nhóm quảng cáo này không thuộc một danh sách phát.

timeOffset

Vị trí của nhóm trong nội dung, tính bằng giây. Quảng cáo đầu video trả về 0, quảng cáo cuối video trả về -1 và quảng cáo trong video trả về thời gian theo lịch của nhóm quảng cáo.

totalAds

Tổng số quảng cáo có trong thời điểm hiển thị quảng cáo này. Giá trị là 1 đối với quảng cáo độc lập.

createAdBreakInfo()


Trả lại ima.AdBreakInfo:

Quay lại đầu trang

Class ima.AdEvent

Trường

Các sự kiện do trình quản lý quảng cáo kích hoạt.

Thuộc tính

Tên Loại Mô tả
AD_PERIOD_ENDED

Sự kiện này sẽ kích hoạt mỗi khi luồng phát chuyển từ quảng cáo hoặc đoạn chặn sang nội dung. Sự kiện này sẽ được kích hoạt ngay cả khi quảng cáo được phát lần thứ hai hoặc khi người dùng tìm đến một quảng cáo.

AD_PERIOD_STARTED

Sự kiện này sẽ kích hoạt mỗi khi luồng phát chuyển từ nội dung sang quảng cáo hoặc đoạn chặn. Sự kiện này sẽ được kích hoạt ngay cả khi quảng cáo được phát lần thứ hai hoặc khi người dùng tìm đến một quảng cáo.

COMPLETE

Được kích hoạt khi quảng cáo phát hết thời lượng.

ERROR

Được kích hoạt khi xảy ra lỗi.

FIRST_QUARTILE

Được kích hoạt khi đầu phát quảng cáo vượt qua tứ phân vị đầu tiên.

ICON_FALLBACK_IMAGE_CLOSED

Được kích hoạt khi người dùng đóng hộp thoại hình ảnh dự phòng của biểu tượng.

ICON_FALLBACK_IMAGE_SHOWN

Được kích hoạt khi hình ảnh dự phòng của biểu tượng xuất hiện.

MIDPOINT

Được kích hoạt khi đầu phát quảng cáo vượt qua điểm giữa.

PROGRESS

Được kích hoạt khi có thông tin cập nhật về tiến trình của quảng cáo.

SKIPPABLE_STATE_CHANGED

Được kích hoạt khi trạng thái có thể bỏ qua của quảng cáo thay đổi.

SKIPPED

Được kích hoạt khi quảng cáo bị bỏ qua.

START

Được kích hoạt khi quảng cáo bắt đầu phát.

THIRD_QUARTILE

Được kích hoạt khi đầu phát quảng cáo vượt qua tứ phân vị thứ ba.

Quay lại đầu trang

Lớp ima.AdInfo

Trường

Phương thức

Chứa thông tin về một quảng cáo. Được SDK truyền đến các lệnh gọi lại sự kiện.

Thuộc tính

Tên Loại Mô tả
adBreakInfo

Thông tin liên quan đến toàn bộ điểm chèn quảng cáo mà quảng cáo này xuất hiện.

adDescription

Nội dung mô tả của quảng cáo.

adId

Mã nhận dạng của quảng cáo hoặc một chuỗi trống nếu không xác định được.

adSystem

Hệ thống quảng cáo cung cấp mẫu quảng cáo.

adTitle

Tiêu đề của quảng cáo.

advertiserName

Tên nhà quảng cáo do bên phân phát xác định.

companions

Quảng cáo đồng hành được chỉ định trong phản hồi VAST.

creativeAdId

Mã ISCI (Giá trị nhận dạng thương mại theo tiêu chuẩn ngành) cho một quảng cáo. Đây là Ad-ID của mẫu quảng cáo đã chọn trong phản hồi VAST.

creativeId

Mã nhận dạng của mẫu quảng cáo đã chọn cho quảng cáo.

currentTime

Thời gian hiện tại trong một quảng cáo tính bằng giây hoặc -1 nếu không xác định được.

dealId

Trả về mã giao dịch đầu tiên có trong chuỗi trình bao bọc cho quảng cáo hiện tại, bắt đầu từ trên cùng.

duration

Thời lượng của quảng cáo đơn này tính bằng giây hoặc -1 nếu không xác định.

skipOffset

Thời gian cần thiết để quảng cáo có thể bỏ qua hoặc -1 nếu không xác định được.

universalAdIDRegistry

Một chuỗi dùng để xác định URL cho trang web đăng ký nơi Mã nhận dạng quảng cáo chung của mẫu quảng cáo đã chọn được lập danh mục.

universalAdIDValue

Universal Ad ID của mẫu quảng cáo đã chọn cho quảng cáo.

wrappers

Một mảng ima.WrapperInfo có thông tin về trình bao bọc cho quảng cáo này. Thứ tự sẽ từ trình bao bọc bên ngoài đến trình bao bọc bên trong.

createAdInfo()


Trả lại ima.AdInfo:

Quay lại đầu trang

Lớp ima.Companion

Trường

Phương thức

Chứa thông tin về quảng cáo đồng hành của một quảng cáo.

Thuộc tính

Tên Loại Mô tả
adSlotId

Mã vị trí quảng cáo của quảng cáo đồng hành. Để trống nếu không có.

apiFramework

API cần thiết để thực thi quảng cáo này hoặc Không hợp lệ nếu không có sẵn.

companionClickThrough

URL nhấp qua của quảng cáo đồng hành.

creativeType

Đại diện cho creativetype thường là một loại MIME.

height

Chiều cao của quảng cáo đồng hành tính bằng pixel. 0 nếu không có.

trackingEvents

Bản đồ theo dõi các sự kiện, trong đó khoá là sự kiện và giá trị là danh sách các URL cần ping khi có sự kiện đó.

url

URL cho tài nguyên tĩnh của thành phần đi kèm này.

width

Chiều rộng của quảng cáo đồng hành, tính bằng pixel. 0 nếu không có.

createCompanion()


Trả lại ima.Companion:

Quay lại đầu trang

Class ima.CuePoint

Trường

Phương thức

Chứa thông tin về một điểm tín hiệu.

Thuộc tính

Tên Loại Mô tả
end

Thời gian kết thúc của một điểm đánh dấu tính bằng giây. Điều này tương ứng với một khoảng thời gian chèn quảng cáo.

hasPlayed

Giá trị boolean cho biết cuepoint đã phát.

start

Thời gian bắt đầu của một điểm đánh dấu tính bằng giây. Điều này tương ứng với một khoảng thời gian chèn quảng cáo.

createCuePoint()


Trả lại ima.CuePoint:

Quay lại đầu trang

Lớp ima.Error

Trường

Phương thức

Đối tượng được truyền đến trình xử lý lỗi nếu có lỗi.

Thuộc tính

Tên Loại Mô tả
id

Mã của lỗi. Hãy xem hằng số ErrorEvent để biết danh sách mã lỗi.

info

Thông tin bổ sung về lỗi.

type

Luôn đặt thành lỗi để cho biết loại đối tượng này.

createError()


Trả lại ima.Error:

Quay lại đầu trang

Class ima.ErrorEvent

Trường

Tất cả các lỗi mà SDK có thể gửi lại.

Thuộc tính

Tên Loại Mô tả
BAD_STREAM_REQUEST

Yêu cầu phát trực tiếp không được điền đúng cách.

COULD_NOT_LOAD_STREAM

Không tải được luồng.

ERROR

Lỗi không xác định.

INVALID_RESPONSE

Phản hồi của máy chủ không hợp lệ.

STREAM_API_KEY_NOT_VALID

Máy chủ không chấp nhận khoá API được cung cấp.

Quay lại đầu trang

Lớp ima.Player

Phương thức

adBreakEnded(adBreakInfo)

Không bắt buộc. Được gọi khi một khoảng thời gian chèn quảng cáo kết thúc.

Thông số Loại Mô tả
adBreakInfo ima.AdBreakInfo

Chứa thông tin về điểm chèn quảng cáo.

adBreakStarted(adBreakInfo)

Không bắt buộc. Được gọi khi một khoảng chèn quảng cáo bắt đầu.

Thông số Loại Mô tả
adBreakInfo ima.AdBreakInfo

Chứa thông tin về điểm chèn quảng cáo.

allVideoComplete()

Không bắt buộc. Được gọi khi tất cả video đã hoàn tất.

createPlayer()

Tạo một đối tượng Player IMA trống. Bạn phải triển khai hàm loadUrl để phát quảng cáo. Các chức năng khác là không bắt buộc.

Trả lại ima.Player:

loadUrl(streamInfo)

Được gọi khi trình phát bắt đầu phát một URL. Bạn phải triển khai phương thức này để tải luồng.

Thông số Loại Mô tả
streamInfo ima.StreamInfo

Chứa thông tin cần thiết để phát nội dung.

streamInitialized(streamInfo)

Được gọi khi một luồng đã được khởi tạo.

Thông số Loại Mô tả
streamInfo ima.StreamInfo

Chứa thông tin cần thiết để phát nội dung.

Quay lại đầu trang

Class ima.StreamFormat

Trường

Xác định định dạng của luồng.

Thuộc tính

Tên Loại Mô tả
DASH

HLS

Quay lại đầu trang

Lớp ima.StreamInfo

Trường

Phương thức

Thông tin được truyền từ SDK đến trình phát về luồng phát.

Thuộc tính

Tên Loại Mô tả
format

Định dạng của video: hls hoặc dash. Được xác định trong ima.StreamFormat.

manifest

URL của sự kiện phát trực tiếp.

streamId

Mã nhận dạng duy nhất của luồng phát.

streamType

Loại video: trực tiếp hoặc theo yêu cầu. Được xác định trong ima.StreamType.

subtitles

Phụ đề (nếu có). Không hợp lệ nếu không.

createStreamInfo()


Trả lại ima.StreamInfo:

Quay lại đầu trang

Class ima.StreamManager

Phương thức

Đối tượng để quản lý chế độ phát trực tuyến.

addEventListener(event, callback)

Thêm một trình nghe cho sự kiện được chỉ định. Hãy xem hằng số AdEvents để biết các sự kiện được hỗ trợ.

Thông số Loại Mô tả
event string

callback function

createStreamManager(streamRequest, streamInitResponse)


Trả lại ima.StreamManager:

Thông số Loại Mô tả
streamRequest ima.StreamRequest

streamInitResponse ima.StreamInitResponse

enableInteractiveAds()

Không được hỗ trợ. Thay vào đó, hãy chuyển dữ liệu từ quảng cáo đồng hành trực tiếp đến RAF. Đây hiện là một thao tác không có hiệu lực.

getContentTime(streamTime)

Lấy thời gian tính bằng mili giây cho một luồng VOD, biểu thị thời gian trong nội dung không có quảng cáo. Để biết thêm thông tin chi tiết, hãy xem phần Câu hỏi thường gặp. Để lấy thời gian nội dung cho thời gian phát trực tiếp hiện tại, hãy truyền -1.

Trả về Integer: Thời gian nội dung tương ứng với thời gian phát trực tiếp đã cho.

Thông số Loại Mô tả
streamTime Integer

Thời gian trong luồng phát.

getCuePoints()

Trả về tất cả điểm đánh dấu thời gian tương ứng với tất cả điểm chèn quảng cáo. Điều này chỉ có hiệu lực đối với nội dung video theo yêu cầu mà tất cả điểm chèn quảng cáo đều được biết trước. Tất cả thời gian đều biểu thị thời gian phát trực tiếp tính bằng giây. Đối với các luồng Cloud Stitching API, thuộc tính hasPlayed của mỗi ima.CuePoint luôn là false.

Trả về Object: Một mảng chứa tất cả các điểm đánh dấu.

getPreviousCuePoint(time)

Trả về điểm đánh dấu trước thời gian này. Điểm đánh dấu cho biết một điểm chèn quảng cáo. Tất cả thời gian đều biểu thị thời gian phát trực tiếp tính bằng giây.

Trả về ima.CuePoint: Một đối tượng có start, end và hasPlayed. Trả về Invalid nếu không có điểm dừng nào.

Thông số Loại Mô tả
time Float

Thời gian tìm kiếm, -1 cho biết thời gian hiện tại và trả về Invalid cho tất cả các luồng khác.

getStreamTime(contentTime)

Lấy thời gian cho luồng từ thời gian nội dung cho VOD tính bằng mili giây. Để biết thêm thông tin chi tiết, hãy xem phần Câu hỏi thường gặp.

Trả về Integer: Thời gian phát trực tiếp tương ứng với thời gian nội dung đã cho.

Thông số Loại Mô tả
contentTime Integer

Thời gian của nội dung.

loadThirdPartyStream(streamManifest, streamSubtitle)

Tải siêu dữ liệu quảng cáo và gọi hàm loadUrl bằng dữ liệu streamManifestUrlstreamSubtitle đã cung cấp. Hàm này chỉ hoạt động khi loại yêu cầu luồng là ima.StreamType.POD_VOD.

Thông số Loại Mô tả
streamManifest string

URL tệp kê khai luồng phát có quảng cáo được ghép.

streamSubtitle ifArray>|Invalid

Phụ đề liên kết với luồng phát hoặc Invalid nếu không có phụ đề.

onMessage(msg)

Xử lý tất cả thông báo đến từ đối tượng Video. Phải được gọi cho từng thông báo nhận được trên roMessagePort.

Thông số Loại Mô tả
msg object

Thông báo từ cổng roVideo.

replaceAdTagParameters(adTagParameters)

Thay thế tất cả các thông số thẻ quảng cáo sẽ đượ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. Xin lưu ý rằng lệnh gọi này không hoạt động đối với luồng VOD.

Thông số Loại Mô tả
adTagParameters string

Các thông số thẻ quảng cáo mới.

start()

Bắt đầu phát luồng.

Quay lại đầu trang

Lớp ima.StreamRequest

Trường

Phương thức

Được dùng để chỉ định các thuộc tính của yêu cầu truyền phát.

Thuộc tính

Tên Loại Mô tả
adTagParameters

Không bắt buộc. Bạn có thể ghi đè một số thông số thẻ quảng cáo trên yêu cầu luồng của mình. Bài viết Cung cấp các thông số nhắm mục tiêu cho luồng của bạn cung cấp thêm thông tin. Bạn cũng có thể sử dụng các tham số dai-ot và dai-ov để ưu tiên phiên bản của luồng phát. Hãy xem phần Ghi đè thông số biến thể trong luồng để biết thêm thông tin.

adUiNode

Một nút biểu đồ cảnh nơi giao diện người dùng quảng cáo hiển thị. IMA đặt các phần tử như nút Tại sao có quảng cáo này và nút Bỏ qua trên phần tử này trong khi quảng cáo đang phát. Phần tử này phải phủ lên toàn bộ phần tử video.

apiKey

Không bắt buộc. Bạn có thể dùng các khoá này để xác thực các yêu cầu phát trực tuyến. Bạn phải thiết lập khoá xác thực DAI trong giao diện người dùng DFP.

assetKey

Bắt buộc đối với sự kiện phát trực tiếp. Tham số này được dùng để xác định luồng nào sẽ được phát. Khoá tài sản của yêu cầu phát trực tiếp là một giá trị nhận dạng mà bạn có thể tìm thấy trong giao diện người dùng DFP.

authToken

Mã uỷ quyền yêu cầu truyền phát trực tiếp. Được dùng thay cho khoá API để có chế độ uỷ quyền nội dung nghiêm ngặt hơn. Nhà xuất bản có thể kiểm soát từng uỷ quyền luồng nội dung dựa trên mã thông báo này.

contentSourceId

Bắt buộc đối với luồng phát theo yêu cầu. cmsid đến từ Nguồn nội dung video DFP trong giao diện người dùng DFP.

customAssetKey

Khoá tài sản tuỳ chỉnh được dùng để xác định luồng phát nào sẽ được phát. Bạn phải có khoá tài sản tuỳ chỉnh cho các yêu cầu phát trực tuyến phân phát nhóm.

format

Định dạng của luồng. Giá trị mặc định là ima.StreamFormat.HLS.

networkCode

Mã mạng của nhà xuất bản đưa ra yêu cầu phát trực tuyến. Bạn phải có mã mạng cho các yêu cầu về luồng phân phát nhóm được thực hiện bằng createPodLiveStreamRequest hoặc createPodVodStreamRequest. Bạn cũng phải có các mã này cho các yêu cầu về luồng kết hợp trên đám mây được thực hiện bằng createVideoStitcherLiveStreamRequest, createVideoStitcherVodStreamRequest hoặc createVideoStitcherVodStreamRequestWithVodConfig. Đây là những mã không bắt buộc và nên dùng cho các yêu cầu về luồng dịch vụ đầy đủ được thực hiện bằng createLiveStreamRequest hoặc createVodStreamRequest. Việc thêm mã mạng sẽ áp dụng các chế độ cài đặt được chọn trong giao diện người dùng Ad Manager, chẳng hạn như việc bật quảng cáo bị hạn chế có lập trình. Đối với tính năng Phân phát nhóm và Ghép nối trên đám mây, việc thêm mã mạng sẽ xác định vị trí và phát luồng phát. Để tìm mã mạng, hãy xem bài viết này.

player

Một cách triển khai giao diện trình phát.

ppid

Không dùng nữa. Sử dụng adTagParameters. Không bắt buộc. Giá trị nhận dạng do nhà xuất bản cung cấp của Đối tượng DFP.

streamActivityMonitorId

Mã nhận dạng dùng để gỡ lỗi luồng bằng trình giám sát hoạt động truyền phát. Điều này giúp nhà xuất bản dễ dàng tìm thấy nhật ký luồng phát trong công cụ theo dõi hoạt động phát trực tiếp.

videoId

Bắt buộc đối với luồng phát theo yêu cầu. Giá trị nhận dạng cho nguồn nội dung video.

videoObject

Đối tượng video (chẳng hạn như Video roSGNode) chịu trách nhiệm phát video trên ứng dụng khách. Đối tượng này sẽ được thăm dò để lấy nhiều dữ liệu được dùng trong việc định thời gian thích hợp cho các sự kiện ID3 HLS trực tiếp.

videoStitcherSessionOptions

Các lựa chọn về phiên được dùng để đặt các thông số cụ thể của trình ghép video cho VideoStitcher streamRequests.

createLiveStreamRequest(assetKey, apiKey, networkCode)

Khởi chạy các thuộc tính bắt buộc của một StreamRequest trực tiếp. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính Live bắt buộc.

Thông số Loại Mô tả
assetKey string

apiKey string

Tham số được chỉ định cho thuộc tính ima.StreamRequest.apiKey của ima.StreamRequest được trả về. Nếu không có khoá API, hãy truyền một chuỗi trống.

networkCode string

Mã mạng của nhà xuất bản đưa ra yêu cầu phát trực tuyến. Bạn không bắt buộc phải thêm mã mạng nhưng vẫn nên làm điều này.

createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)

Khởi chạy các thuộc tính bắt buộc của Pod Live ima.StreamRequest. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho ima.StreamType bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính PodLive bắt buộc.

Thông số Loại Mô tả
customAssetKey string

networkCode string

apiKey string

Tham số không bắt buộc được chỉ định cho thuộc tính ima.StreamRequest của ima.StreamRequest.apiKey được trả về; mặc định là chuỗi trống.

createPodVodStreamRequest(networkCode)

Khởi chạy các thuộc tính bắt buộc của ima.StreamRequest để đăng ký luồng VOD khi sử dụng tính năng phân phát nhóm DAI với một trình ghép video bên thứ ba. Hàm này đặt loại yêu cầu thành ima.StreamType.POD_VOD và xác thực tất cả các thuộc tính bắt buộc đối với dữ liệu bị thiếu. Các quy trình xác thực không thành công sẽ ghi lại một lỗi trong bảng điều khiển gỡ lỗi.

Trả về StreamRequest: một đối tượng ima.StreamRequest. Nếu bạn chỉ định tất cả các thuộc tính bắt buộc, thì loại yêu cầu sẽ được đặt thành ima.StreamType.POD_VOD.

Thông số Loại Mô tả
networkCode string

mã mạng Google Ad Manager

createStreamRequest()


Trả về ima.StreamRequest: Một đối tượng ima.StreamRequest trống.

createVideoStitcherLiveStreamRequest(customAssetKey, networkCode, liveConfigId, region, projectNumber, oAuthToken)

Khởi chạy các thuộc tính bắt buộc của Video Stitcher Live StreamRequest. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về ima.StreamRequest: Đối tượng ima.StreamRequest có các thuộc tính VideoStitcherLive bắt buộc.

Thông số Loại Mô tả
customAssetKey string

networkCode string

liveConfigId string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequest(adTagUrl, networkCode, contentSourceUrl, region, projectNumber, oAuthToken)

Khởi chạy các thuộc tính bắt buộc của Video Stitcher VOD StreamRequest. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về ima.StreamRequest: đối tượng ima.StreamRequest có các thuộc tính VideoStitcherVod bắt buộc.

Thông số Loại Mô tả
adTagUrl string

networkCode string

contentSourceUrl string

region string

projectNumber string

oAuthToken string

createVideoStitcherVodStreamRequestWithVodConfig(vodConfigId, networkCode, region, projectNumber, oAuthToken)

Khởi chạy các thuộc tính bắt buộc của Video Stitcher VOD StreamRequest bằng cách sử dụng vodConfigId được tạo từ công cụ kết hợp video trên đám mây. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho StreamType bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về ima.StreamRequest: đối tượng ima.StreamRequest có các thuộc tính VideoStitcherVod bắt buộc.

Thông số Loại Mô tả
vodConfigId string

networkCode string

region string

projectNumber string

oAuthToken string

createVodStreamRequest(contentSourceId, videoId, apiKey, networkCode)

Khởi chạy các thuộc tính bắt buộc của một ima.StreamRequest VOD. Việc sử dụng API này sẽ khiến mọi thuộc tính khác dành riêng cho ima.StreamType đều bị bỏ qua. Nếu bất kỳ tham số bắt buộc nào là chuỗi trống, thì quá trình ghi nhật ký lỗi sẽ diễn ra và API sẽ trả về một StreamRequest chung mà không bỏ qua thuộc tính nào.

Trả về ima.StreamRequest: đối tượng ima.StreamRequest có các thuộc tính VOD bắt buộc.

Thông số Loại Mô tả
contentSourceId string

videoId string

apiKey string

Tham số được chỉ định cho thuộc tính ima.StreamRequest.apiKey của ima.StreamRequest được trả về. Nếu không có khoá API, hãy truyền một chuỗi trống.

networkCode string

Mã mạng của nhà xuất bản đưa ra yêu cầu phát trực tuyến. Bạn không bắt buộc phải thêm mã mạng nhưng vẫn nên làm điều này.

Quay lại đầu trang

Class ima.StreamType

Trường

Xác định loại luồng mà trình phát được yêu cầu phát. Quảng cáo trước video và video theo yêu cầu phải phát từ đầu luồng phát.

Thuộc tính

Tên Loại Mô tả
LIVE

Video này đã xuất hiện công khai.

VOD

Bạn có thể xem video này theo yêu cầu.

Quay lại đầu trang

Lớp ima.WrapperInfo

Trường

Phương thức

Chứa thông tin về một trình bao bọc.

Thuộc tính

Tên Loại Mô tả
adId

Mã nhận dạng của quảng cáo hoặc một chuỗi trống nếu không xác định được.

adSystem

Tên đã khai báo của hệ thống quảng cáo hoặc một chuỗi trống nếu không xác định.

creativeAdId

Mã quảng cáo trên mẫu quảng cáo hoặc một chuỗi trống nếu không xác định được.

creativeId

Mã nhận dạng của mẫu quảng cáo hoặc một chuỗi trống nếu không xác định được.

dealId

Mã ưu đãi hoặc một chuỗi trống nếu không xác định được.

createWrapperInfo()


Trả lại ima.WrapperInfo:

Quay lại đầu trang