Lớp: CastReceiverContext

cast.framework.CastReceiverContext

class   static

Quản lý việc tải các thư viện cơ bản và khởi chạy SDK trình nhận truyền cơ bản.

Gửi

non-null Error Nếu MediaElement không được tạo trên phần nội dung của tài liệu. Nếu tạo nhiều phần tử nội dung nghe nhìn, nhà phát triển nên đặt lớp "castMediaElement" cho một trong các phần tử đó, trình nhận CAF sẽ sử dụng phần tử này.

Phương thức

getInstance

static

getInstance() trả về cast.framework.CastReceiverContext

Trả về thực thể singleton CastReceiverContext.

Giá trị trả về

non-null cast.framework.CastReceiverContext 

addCustomMessageListener

addCustomMessageListener(namespace, listener)

Thiết lập trình nghe thông báo cho một kênh thông báo tuỳ chỉnh. Bạn có thể sử dụng nhiều trình nghe cho một không gian tên.

Tham số

không gian tên

chuỗi

Không gian tên. Xin lưu ý rằng không gian tên hợp lệ phải có tiền tố là chuỗi "urn:x-cast:".

trình nghe

function(non-null cast.framework.system.Message)
Gửi

Error Nếu hệ thống chưa sẵn sàng hoặc không gian tên không được ứng dụng này hỗ trợ.

addEventListener

addEventListener(type, handler)

Thêm trình nghe vào các sự kiện của hệ thống truyền.

Tham số

loại

cast.framework.system.EventType

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

trình xử lý

function(non-null cast.framework.system.Event)

canDisplayType

canDisplayType(mimeType, codecs, width, height, framerate) trả về boolean

Kiểm tra xem các thông số nội dung nghe nhìn đã cho của luồng video hoặc luồng âm thanh có được nền tảng hỗ trợ hay không.

Tham số

mimeType

chuỗi

Loại MIME của nội dung nghe nhìn. Loại này bao gồm một loại và loại phụ được phân tách bằng dấu "/". Đây có thể là loại mime video hoặc âm thanh.

bộ mã hoá và giải mã

Không bắt buộc

chuỗi

Chuỗi được trích dẫn chứa danh sách được phân tách bằng dấu phẩy các định dạng, trong đó mỗi định dạng chỉ định một loại mẫu nội dung nghe nhìn có trong luồng.

chiều rộng

Không bắt buộc

số

Mô tả độ phân giải ngang của luồng, tính bằng pixel.

chiều cao

Không bắt buộc

số

Mô tả độ phân giải dọc của luồng tính bằng pixel.

tốc độ khung hình

Không bắt buộc

số

Mô tả tốc độ khung hình của luồng.
Giá trị trả về

boolean Nếu có thể phát luồng trên Chromecast.

getApplicationData

getApplicationData() trả về cast.framework.system.ApplicationData

Cung cấp thông tin ứng dụng khi hệ thống đã sẵn sàng, nếu không thì thông tin này sẽ rỗng.

Giá trị trả về

nullable cast.framework.system.ApplicationData Thông tin ứng dụng hoặc giá trị rỗng nếu hệ thống chưa sẵn sàng.

getDeviceCapabilities

getDeviceCapabilities() trả về cast.framework.system.DeviceCapabilitiesObj

Cung cấp thông tin về chức năng của thiết bị khi hệ thống đã sẵn sàng, nếu không thì giá trị sẽ là rỗng. Nếu hệ thống trả về một đối tượng trống, thì thiết bị sẽ không hiển thị thông tin về chức năng.

Giá trị trả về

nullable cast.framework.system.DeviceCapabilitiesObj Thông tin về chức năng của thiết bị (cặp khoá/giá trị). Giá trị này sẽ rỗng nếu hệ thống chưa sẵn sàng. Đây có thể là một đối tượng trống nếu nền tảng không hiển thị bất kỳ thông tin nào về chức năng của thiết bị.

getDeviceInformation

getDeviceInformation() trả về cast.framework.system.DeviceInformationObj

Cung cấp thông tin nhận dạng thiết bị không liên quan đến chức năng sau khi hệ thống sẵn sàng, nếu không thì thông tin này sẽ là "null". Nếu hệ thống trả về một đối tượng trống, thì thiết bị sẽ không hiển thị thông tin đó.

Giá trị trả về

nullable cast.framework.system.DeviceInformationObj Thông tin thiết bị (cặp khoá/giá trị). Giá trị này sẽ rỗng nếu hệ thống chưa sẵn sàng. Đây có thể là một đối tượng trống nếu nền tảng không hiển thị thông tin này.

getPlayerManager

getPlayerManager() trả về cast.framework.PlayerManager

Lấy thực thể Player có thể điều khiển và giám sát việc phát nội dung nghe nhìn.

Giá trị trả về

non-null cast.framework.PlayerManager 

getSender

getSender(senderId) trả về cast.framework.system.Sender

Lấy thông tin người gửi theo mã nhận dạng người gửi

Tham số

senderId

chuỗi

Mã nhận dạng của người gửi cần trả về.
Giá trị trả về

nullable cast.framework.system.Sender 

getSenders

getSenders() returns Array of non-null cast.framework.system.Sender

Lấy danh sách người gửi hiện đang kết nối.

Giá trị trả về

non-null Array of non-null cast.framework.system.Sender 

getStandbyState

getStandbyState() trả về cast.framework.system.StandbyState

Báo cáo nếu đầu vào HDMI của ứng dụng truyền đang ở chế độ chờ.

Giá trị trả về

non-null cast.framework.system.StandbyState Liệu đầu vào HDMI của ứng dụng có ở chế độ chờ hay không. Nếu không thể xác định được, chẳng hạn như do TV không hỗ trợ lệnh CEC, thì giá trị được trả về là UNKNOWN.

getSystemState

getSystemState() trả về cast.framework.system.SystemState

Cung cấp thông tin ứng dụng về trạng thái hệ thống.

Giá trị trả về

non-null cast.framework.system.SystemState Trạng thái hệ thống.

getVisibilityState

getVisibilityState() trả về cast.framework.system.VisibilityState

Báo cáo nếu ứng dụng truyền là đầu vào HDMI đang hoạt động.

Giá trị trả về

non-null cast.framework.system.VisibilityState Liệu ứng dụng có phải là đầu vào HDMI đang hoạt động hay không. Nếu không thể xác định được (ví dụ: do TV không hỗ trợ lệnh CEC), thì giá trị trả về là UNKNOWN.

isSystemReady

isSystemReady() trả về boolean

Khi ứng dụng gọi start, hệ thống sẽ gửi sự kiện ready để cho biết rằng thông tin ứng dụng đã sẵn sàng và ứng dụng có thể gửi thông báo ngay khi có một người gửi kết nối.

Giá trị trả về

boolean Liệu hệ thống đã sẵn sàng xử lý thông báo hay chưa.

loadPlayerLibraries

loadPlayerLibraries(useLegacyDashSupport)

Bắt đầu tải tệp JavaScript của trình phát. Bạn có thể dùng thuộc tính này để bắt đầu tải mã js của trình phát ở giai đoạn đầu của quá trình khởi động trình thu trước khi gọi phương thức start. Hàm này không hoạt động nếu trình phát đã được tải (bắt đầu được gọi).

Tham số

useLegacyDashSupport

Không bắt buộc

boolean

Cho biết rằng MPL nên được dùng cho nội dung DASH.

removeCustomMessageListener

removeCustomMessageListener(namespace, listener)

Xoá trình nghe tin nhắn đã đăng ký trước đó bằng CastReceiverContext#addCustomMessageListener.

Tham số

không gian tên

chuỗi

Không gian tên. Xin lưu ý rằng không gian tên hợp lệ phải có tiền tố là chuỗi "urn:x-cast:".

trình nghe

function(non-null cast.framework.system.Message)

Hàm trình nghe thông báo cần huỷ đăng ký.
Gửi

Error Nếu hệ thống chưa sẵn sàng hoặc không gian tên không được ứng dụng này hỗ trợ.

removeEventListener

removeEventListener(type, handler)

Xoá trình nghe để truyền các sự kiện hệ thống.

Tham số

loại

cast.framework.system.EventType

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

trình xử lý

function(non-null cast.framework.system.Event)

sendCustomMessage

sendCustomMessage(namespace, senderId, data)

Gửi tin nhắn cho một người gửi cụ thể.

Tham số

không gian tên

chuỗi

Không gian tên. Xin lưu ý rằng không gian tên hợp lệ phải có tiền tố là chuỗi "urn:x-cast:".

senderId

(chuỗi hoặc không xác định)

SenderId hoặc không xác định để truyền phát cho tất cả người gửi.

khác

mọi loại

Trọng tải thông báo.

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

Error Nếu xảy ra lỗi khi chuẩn bị thông báo.

sendFeedbackMessage

sendFeedbackMessage(feedbackMessage)

Hàm này sẽ được gọi để phản hồi sự kiện feedbackstarted nếu ứng dụng thêm thông tin trạng thái gỡ lỗi để ghi nhật ký trong báo cáo ý kiến phản hồi. Hàm này nhận một tham số "message" là một chuỗi đại diện cho thông tin gỡ lỗi mà ứng dụng muốn ghi nhật ký.

Tham số

feedbackMessage

chuỗi
Không được dùng nữa
Sử dụng cast.framework.CastReceiverContext#setFeedbackHandler

setApplicationState

setApplicationState(statusText)

Đặt trạng thái ứng dụng. Ứng dụng nên gọi phương thức này khi trạng thái của ứng dụng thay đổi. Nếu không được xác định hoặc được đặt thành một chuỗi trống, thì giá trị của Tên ứng dụng được thiết lập trong quá trình đăng ký ứng dụng sẽ được dùng cho trạng thái ứng dụng theo mặc định.

Tham số

statusText

chuỗi

Văn bản trạng thái.

setFeedbackHandler

setFeedbackHandler(feedbackHandler)

Đặt trình xử lý để cung cấp thêm dữ liệu cho báo cáo ý kiến phản hồi. Trình xử lý sẽ được gọi khi một báo cáo ý kiến phản hồi được tạo và sẽ trả về dữ liệu bổ sung dưới dạng chuỗi hoặc lời hứa chuỗi. Lời hứa trả về phải được giải quyết trong vòng 5 giây để được đưa vào báo cáo.

Tham số

feedbackHandler

function()

Giá trị có thể rỗng.

setInactivityTimeout

setInactivityTimeout(maxInactivity)

Đặt thời gian chờ khi thiết bị nhận không hoạt động. Bạn nên đặt giá trị không hoạt động tối đa khi gọi Start và không thay đổi giá trị đó. API này chỉ được cung cấp cho mục đích phát triển/gỡ lỗi.

Tham số

maxInactivity

số

Khoảng thời gian tính bằng giây trước khi đóng một kết nối không phản hồi.

setLoggerLevel

setLoggerLevel(level)

Đặt mức độ chi tiết của nhật ký.

Tham số

cấp độ

cast.framework.LoggerLevel

Cấp độ ghi nhật ký.

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

start

start(options) trả về cast.framework.CastReceiverContext

Khởi chạy trình quản lý hệ thống và trình quản lý nội dung nghe nhìn để ứng dụng nhận có thể nhận yêu cầu từ người gửi.

Tham số

tùy chọn

(cast.framework.CastReceiverOptions không rỗng hoặc Đối tượng không rỗng không bắt buộc)
Giá trị trả về

non-null cast.framework.CastReceiverContext 

điểm dừng

stop(closeReason)

Tắt ứng dụng nhận.

Tham số

closeReason

Không bắt buộc

cast.framework.common.CloseReason

Lý do đóng không bắt buộc cho biết lý do ứng dụng nhận bị dừng. Nếu không được cung cấp, khung sẽ suy luận lý do dựa trên các sự kiện gần đây của trình phát nội dung nghe nhìn hoặc quay lại APP_REQUEST. Truyền một trong các giá trị số sau:

  • 13 (APP_CUSTOM_STOP): Đối với các hành động kinh doanh/giao diện người dùng của trình nhận tuỳ chỉnh (ví dụ: người dùng nhấp vào nút "Thoát" hoặc "Đóng" trong ứng dụng, trình nhận tuỳ chỉnh điều hướng khỏi quá trình truyền).
  • 15 (APP_ERROR): Lỗi nghiêm trọng ở cấp ứng dụng (ví dụ: lỗi xác thực tuỳ chỉnh, lỗi truy xuất DRM/giấy phép, lỗi API phụ trợ) xảy ra bên ngoài các sự kiện lỗi của trình phát tích hợp sẵn trong CAF.
  • 14 (APP_PLAYBACK_FINISHED): Ứng dụng đã phát hết danh sách phát/hàng đợi hoặc hoàn tất một trải nghiệm nghe nhìn độc lập.
  • 6 (APP_REQUEST): Dự phòng chung/cũ khi một ứng dụng yêu cầu chấm dứt mà không có lý do cụ thể hơn.

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