Lớp ima
Phương thức
Các hàm chung điều khiển SDK IMA.
disableLogging()
Tắt tính năng ghi nhật ký SDK. Tính năng ghi nhật ký sẽ được bật theo mặc định.
getStreamManager()
Trả về trình quản lý luồng nếu có.
Nếu chưa có trình quản lý luồng, giá trị Không hợp lệ sẽ được trả về.
Nếu xảy ra lỗi khi tạo trình quản lý luồng, hệ thống sẽ trả về một đối tượng lỗi.
Trả về object: Trình quản lý sự kiện phát trực tiếp hoặc đối tượng lỗi.
initSdk(settings)
Khởi chạy SDK.
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
settings |
object |
Đối tượng cài đặt IMA không bắt buộc. |
requestStream(streamRequest)
Bắt đầu yêu cầu luồng không đồng bộ
Chế độ kiểm soát sẽ trả về ngay lập tức cho người chơi 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 | Nội dung mô tả |
|---|---|---|
streamRequest |
object |
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 | Nội dung mô tả |
|---|---|---|
adPosition |
|
Chỉ mục của quảng cáo trong điểm chèn quảng cáo. Sẽ là số 1 cho quảng cáo độc lập. |
duration |
|
Thời lượng tối đa của điểm chèn quảng cáo tính bằng giây hoặc -1 nếu không xác định. |
podIndex |
|
Đối với sự kiện phát trực tiếp, luôn trả về -1. Đối với video theo yêu cầu (VOD), hàm sẽ trả về chỉ mục của nhóm quảng cáo. Đối với nhóm đầu video, giá trị trả về là 0. Đối với quảng cáo giữa video, hàm sẽ trả về 1, 2, ..., n. Đối với một nhóm cuối video, hãy trả về n+1...n+x. Giá trị mặc định là 0 nếu quảng cáo này không thuộc một nhóm hoặc nhóm này không thuộc 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 trước video trả về 0, quảng cáo sau video trả về -1 và quảng cáo trong video trả về thời gian đã lên lịch của nhóm. |
totalAds |
|
Tổng số quảng cáo có trong điểm chèn quảng cáo này. Sẽ là số 1 cho quảng cáo độc lập. |
createAdBreakInfo()
Trả về ima.AdBreakInfo:
Lớp ima.AdEvent
Trường
Các sự kiện do người quản lý quảng cáo kích hoạt.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
AD_PERIOD_ENDED |
|
Được kích hoạt mỗi khi luồng chuyển từ quảng cáo hoặc phương tiện chặn sang nội dung. Lệnh này sẽ được kích hoạt ngay cả khi người dùng phát quảng cáo lần thứ hai hoặc khi tìm kiếm một quảng cáo. |
AD_PERIOD_STARTED |
|
Được kích hoạt mỗi khi luồng chuyển từ nội dung sang quảng cáo hoặc phương tiện chặn. Lệnh này sẽ được kích hoạt ngay cả khi người dùng phát quảng cáo lần thứ hai hoặc khi tìm kiếm một quảng cáo. |
COMPLETE |
|
Được kích hoạt khi quảng cáo phát xong. |
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 phần tư đầ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 biểu tượng. |
ICON_FALLBACK_IMAGE_SHOWN |
|
Được kích hoạt khi hình ảnh dự phòng biểu tượng hiển thị. |
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 phần tư thứ ba. |
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 | Nội dung mô tả |
|---|---|---|
adBreakInfo |
|
Thông tin liên quan đến toàn bộ điểm chèn quảng cáo này. |
adDescription |
|
Nội dung mô tả của quảng cáo. |
adId |
|
Mã của quảng cáo hoặc một chuỗi trống nếu không xác định. |
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. |
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. |
duration |
|
Thời lượng của quảng cáo này tính bằng giây hoặc -1 nếu không xác định. |
skipOffset |
|
Thời gian để quảng cáo trở thành có thể bỏ qua hoặc -1 nếu không xác định. |
universalAdIDRegistry |
|
Chuỗi được dùng để xác định URL cho trang web đăng ký, trong đó Mã quảng cáo chung của mẫu quảng cáo đã chọn được liệt kê trong danh mục. |
universalAdIDValue |
|
Mã quảng cáo chung 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ẽ là từ trình bao bọc bên ngoài đến bên trong. |
createAdInfo()
Trả về ima.AdInfo:
Lớp ima.đồng hành
Trường
Phương thức
Chứa thông tin về các thành phần đồng hành của quảng cáo.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
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. |
creativeType |
|
Đại diện cho loại mẫu quảng cáo thường là mimetype. |
height |
|
Chiều cao của quảng cáo đồng hành tính bằng pixel. 0 nếu không có sẵn. |
trackingEvents |
|
Bản đồ các sự kiện theo dõi, trong đó khoá là sự kiện và giá trị là danh sách URL để ping dựa trên sự kiện đó. |
url |
|
URL cho tài nguyên tĩnh của đồng hành 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ó sẵn. |
createCompanion()
Trả về ima.Companion:
Lớp ima.CuePoint
Trường
Phương thức
Chứa thông tin về một điểm dừng.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
end |
|
Thời gian kết thúc cho một điểm dừng tính bằng giây. Điều này tương ứng với một điểm chèn quảng cáo. |
hasPlayed |
|
Giá trị boolean cho biết điểm dừng đã được phát. |
start |
|
Thời gian bắt đầu cho một điểm dừng tính bằng giây. Điều này tương ứng với một điểm chèn quảng cáo. |
createCuePoint()
Trả về ima.CuePoint:
Lớp ima.Error
Trường
Phương thức
Đối tượng được truyền cho trình xử lý lỗi nếu có lỗi.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
id |
|
Mã của lỗi. Xem hằng số ErrorEvent để biết danh sách các 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ả về ima.Error:
Lớp ima.ErrorEvent
Trường
Tất cả lỗi mà SDK có thể gửi lại.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
BAD_STREAM_REQUEST |
|
Yêu cầu luồng không được điền chính xác. |
COULD_NOT_LOAD_STREAM |
|
Không thể tải 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 đã cung cấp. |
Lớp ima.Player
Phương thức
adBreakEnded(adBreakInfo)
Không bắt buộc. Được gọi khi một điểm chèn quảng cáo đã kết thúc.
| Thông số | Loại | Nội dung 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 điểm chèn quảng cáo bắt đầu.
| Thông số | Loại | Nội dung 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 đối tượng IMA Player trống. Bạn phải triển khai hàm
loadUrl để phát quảng cáo. Các hàm khác là không bắt buộc.
Trả về 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 | Nội dung mô tả |
|---|---|---|
streamInfo |
ima.StreamInfo |
Chứa thông tin cần thiết để phát nội dung. |
Lớp ima.StreamFormat
Trường
Xác định định dạng của luồng.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
DASH |
|
|
HLS |
|
Lớp ima.StreamInfo
Trường
Phương thức
Thông tin được truyền từ SDK đến người chơi về luồng.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
format |
|
Định dạng video: hls hoặc dấu gạch ngang. Được xác định trong ima.StreamFormat. |
manifest |
|
URL cho luồng. |
streamId |
|
Mã nhận dạng duy nhất của luồng. |
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ả về ima.StreamInfo:
Lớp ima.StreamManager
Phương thức
Đối tượng để quản lý việc phát luồng.
addEventListener(event, callback)
Thêm trình nghe cho sự kiện đã chỉ định. Xem hằng số AdEvents để biết các sự kiện được hỗ trợ.
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
event |
string |
|
callback |
function |
createStreamManager(streamRequest, streamInitResponse)
Trả về ima.StreamManager:
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
streamRequest |
ima.StreamRequest |
|
streamInitResponse |
ima.StreamInitResponse |
enableInteractiveAds()
Không được hỗ trợ. Thay vào đó, hãy truyền dữ liệu từ quảng cáo đồng hành sang RAF trực tiếp.
Địa điểm này hiện không còn hoạt động.
getContentTime(streamTime)
Lấy thời gian tính bằng mili giây cho luồng VOD, thể hiện thời gian trong nội dung không có quảng cáo.
Hãy xem bài viết: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Để biết thời lượng nội dung trong khoảng thời gian phát trực tiếp hiện tại, hãy nhập giá trị -1.
Trả về Integer: Thời gian nội dung tương ứng với thời gian phát trực tiếp nhất định.
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
streamTime |
Integer |
Thời gian trong luồng. |
getCuePoints()
Trả về tất cả các điểm dừng tương ứng với tất cả điểm chèn quảng cáo. Mã này chỉ hợp lệ đối với nội dung video theo yêu cầu mà trong đó đã xác định trước tất cả các điểm chèn quảng cáo. Tất cả thời gian đều thể hiện thời gian phát trực tiếp tính bằng giây.
Trả về Object: Một mảng có tất cả các điểm dừng.
getPreviousCuePoint(time)
Trả về điểm dừng trước thời gian này. Điểm dừng cho biết điểm chèn
quảng cáo. Tất cả thời gian đều thể hiện 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ó điểm bắt đầu, kết thúc và hasPlayed. Trả về
Không hợp lệ nếu không có điểm dừng.
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
time |
Float |
Thời gian để tra cứu, -1 biểu thị thời gian hiện tại. |
getStreamTime(contentTime)
Lấy thời gian cho sự kiện phát trực tiếp từ một thời điểm nội dung cho VOD theo mili giây.
Hãy xem bài viết: https://developers.google.com/ad-manager/dynamic-ad-insertion/sdk/roku/faq
Trả về Integer: Thời gian phát trực tiếp tương ứng với thời lượng nội dung đã chọn.
| Thông số | Loại | Nội dung 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 streamManifestUrl và streamSubtitle
được 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 | Nội dung mô tả |
|---|---|---|
streamManifest |
string |
URL tệp kê khai của luồng có quảng cáo được ghép. |
streamSubtitle |
ifArray |
Phụ đề liên kết với luồng hoặc |
onMessage(msg)
Xử lý tất cả các thông báo đến từ đối tượng Video.
Phải được gọi cho mỗi tin nhắn nhận được trên roMessagePort.
| Thông số | Loại | Nội dung 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 được sử dụng cho các yêu cầu quảng cáo sắp tới cho luồng trực tiếp. Xin lưu ý rằng lệnh gọi này không hoạt động đối với các luồng VOD.
| Thông số | Loại | Nội dung mô tả |
|---|---|---|
adTagParameters |
string |
Thông số thẻ quảng cáo mới. |
start()
Bắt đầu phát sự kiện trực tiếp.
Lớp ima.StreamRequest
Trường
Phương thức
Dùng để chỉ định các thuộc tính của yêu cầu luồng.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
adTagParameters |
|
Không bắt buộc. Bạn có thể ghi đè một tập hợp giới hạn các thông số thẻ quảng cáo lên yêu cầu luồng của mình. Bạn có thể xem thêm thông tin trong bài viết Cung cấp tham số nhắm mục tiêu cho luồng của mình. Bạn cũng có thể sử dụng các tham số dai-ot và dai-ov cho lựa chọn ưu tiên về biến thể của luồng. Hãy xem bài viết Ghi đè các tham số biến thể trong luồng để biết thêm thông tin. |
adUiNode |
|
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à Bỏ qua trên phần tử này trong quảng cáo. Phần tử này phải phủ 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 luồng phát. Khoá xác thực DAI phải được thiết lập trong giao diện người dùng DFP. |
assetKey |
|
Bắt buộc đối với sự kiện trực tiếp. Thông tin này dùng để xác định xem sẽ phát luồng nào. Khoá nội dung yêu cầu phát trực tiếp là giá trị nhận dạng có thể được tìm thấy trong giao diện người dùng DFP. |
authToken |
|
Mã thông báo uỷ quyền yêu cầu luồng. Được dùng thay cho khoá API để uỷ quyền nội dung nghiêm ngặt hơn. Nhà xuất bản có thể kiểm soát các hoạt động uỷ quyền luồng nội dung riêng lẻ dựa trên mã thông báo này. |
contentSourceId |
|
Bắt buộc đối với các sự kiện trực tiếp 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á thành phần tuỳ chỉnh dùng để xác định xem nên phát sự kiện trực tiếp nào. Bạn cần có khoá thành phần tuỳ chỉnh cho các yêu cầu luồng phân phát nhóm. |
format |
|
Định dạng của luồng. Giá trị mặc định là |
networkCode |
|
Mã mạng cho nhà xuất bản đưa ra yêu cầu phát trực tuyến. Bạn cần có mã mạng để gửi các yêu cầu luồng phân phát nhóm. |
player |
|
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 cho Đố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 của luồng. Tính năng này được dùng để cho phép nhà xuất bản tìm thấy nhật ký luồng trong công cụ giám sát hoạt động phát trực tuyến một cách thuận tiện. |
videoId |
|
Bắt buộc đối với các sự kiện trực tiếp theo yêu cầu. Giá trị nhận dạng của 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ò ý kiến để xác định nhiều dữ liệu dùng để xác định đúng thời gian cho các sự kiện Live HLS ID3. |
videoStitcherSessionOptions |
|
Các tuỳ chọn phiên được dùng để đặt các tham số cụ thể liên kết video cho VideoStitcher streamRequests. |
createLiveStreamRequest(assetKey, apiKey)
Khởi chạy các thuộc tính bắt buộc của 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 mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung mô tả |
|---|---|---|
assetKey |
string |
|
apiKey |
string |
Tham số không bắt buộc sẽ được gán cho thuộc tính |
createPodLiveStreamRequest(customAssetKey, networkCode, apiKey)
Khởi chạy các thuộc tính bắt buộc của ima.StreamRequest Pod Live.
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 mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung mô tả |
|---|---|---|
customAssetKey |
string |
|
networkCode |
string |
|
apiKey |
string |
Tham số không bắt buộc sẽ được gán cho thuộc tính |
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 công cụ kết hợp video của 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 để tìm dữ liệu bị thiếu. Các lần xác thực không thành công sẽ ghi nhận lỗi trong bảng điều khiển gỡ lỗi.
Trả về StreamRequest: đố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 | Nội dung 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 StreamRequest Công cụ ghép video 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 sẽ bị bỏ qua.
Nếu mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung 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 VOD StreamRequest cho Công cụ kết hợp video. 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 sẽ bị bỏ qua.
Nếu mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung 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 theo yêu cầu trong Công cụ ghép video StreamRequest bằng vodConfigId được tạo từ công cụ ghé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 mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung mô tả |
|---|---|---|
vodConfigId |
string |
|
networkCode |
string |
|
region |
string |
|
projectNumber |
string |
|
oAuthToken |
string |
createVodStreamRequest(contentSourceId, videoId, apiKey)
Khởi tạo các thuộc tính bắt buộc của VOD 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 mọi tham số bắt buộc đều là chuỗi trống, thì việc ghi nhật ký lỗi sẽ xảy ra và API 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 | Nội dung mô tả |
|---|---|---|
contentSourceId |
string |
|
videoId |
string |
|
apiKey |
string |
Tham số không bắt buộc sẽ được gán cho thuộc tính |
Lớp 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à VOD phải phát từ đầu sự kiện phát trực tiếp.
Thuộc tính
| Tên | Loại | Nội dung mô tả |
|---|---|---|
LIVE |
|
Video này đã xuất hiện công khai. |
VOD |
|
Video này đang theo yêu cầu. |
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 | Nội dung mô tả |
|---|---|---|
adId |
|
Mã của quảng cáo hoặc một chuỗi trống nếu không xác định. |
adSystem |
|
Tên được khai báo của hệ thống quảng cáo hoặc và 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. |
creativeId |
|
Mã của mẫu quảng cáo hoặc một chuỗi trống nếu không xác định. |
dealId |
|
Mã giao dịch hoặc chuỗi trống nếu không xác định. |
createWrapperInfo()
Trả về ima.WrapperInfo: