کلاس: جلسه

کروم قالب . جلسه

کلاس ایستا

وضعیت برنامه Cast در حال اجرا را شرح می دهد. به طور معمول، این اشیاء نباید توسط مشتری ایجاد شوند.

سازنده

جلسه

جلسه جدید (sessionId، appId، displayName، appImages، گیرنده)

پارامتر
شناسه جلسه	رشته شناسه جلسه
شناسه برنامه	رشته شناسه برنامه گیرنده
نمایش نام	رشته نام نمایشی برنامه
تصاویر برنامه	آرایه ای از chrome.cast.Image غیر تهی تصاویر مرتبط با برنامه مقدار نباید صفر باشد.
گیرنده	chrome.cast.گیرنده گیرنده ای که برنامه را اجرا می کند. مقدار نباید صفر باشد.

خواص

شناسه برنامه

رشته

شناسه برنامه Cast. برای نمایش نیست

تصاویر برنامه

آرایه غیر تهی chrome.cast.Image غیر تهی

مجموعه ای از تصاویر موجود که برنامه را توصیف می کنند.

نمایش نام

رشته

نام قابل خواندن توسط انسان برنامه Cast، به عنوان مثال، "YouTube".

رسانه ها

آرایه غیر تهی chrome.cast.media.media

رسانه‌هایی که به این جلسه Cast تعلق دارند، از جمله رسانه‌هایی که توسط فرستندگان دیگر بارگیری شده‌اند.

فضاهای نام

آرایه غیر تهی {name: string}

لیستی از فضاهای نام پشتیبانی شده توسط برنامه گیرنده.

گیرنده

chrome.cast.receiver غیر تهی

گیرنده ای که برنامه را اجرا می کند.

senderApps

آرایه غیر تهی از chrome.cast.SenderApplication غیر تهی

برنامه های فرستنده که توسط برنامه گیرنده پشتیبانی می شوند. این ممکن است برای ترغیب کاربر برای نصب یا بازدید از برنامه فرستنده استفاده شود.

شناسه جلسه

رشته

منحصر به فرد این نمونه از برنامه گیرنده را شناسایی می کند.

وضعیت

chrome.cast.SessionStatus غیر تهی

وضعیت این جلسه Cast به برنامه گیرنده.

وضعیت متن

رشته پوچ

متن توصیفی برای محتوای برنامه فعلی، به عنوان مثال "نمایش اسلاید عروسی من".

شناسه حمل و نقل

رشته

شناسه‌ای که به‌طور منحصربه‌فردی این جلسه را برای اهداف حمل‌ونقل توصیف می‌کند. این کانال ارتباطی داخلی است.

مواد و روش ها

افزودن MediaListener

addMediaListener(شنونده)

شنونده ای اضافه می کند که هنگام ایجاد یک جلسه رسانه توسط فرستنده دیگری فراخوانی می شود.

پارامتر
شنونده	تابع (غیر تهی chrome.cast.media.Media ) شنونده برای اضافه کردن.

addMessageListener

addMessageListener (فضای نام، شنونده)

شنونده ای را اضافه می کند که هنگام دریافت پیام از برنامه گیرنده فراخوانی می شود. شنونده با فضای نام به عنوان آرگومان اول و پیام به عنوان آرگومان دوم فراخوانی می شود.

پارامتر
فضای نام	رشته فضای نام برای گوش دادن، به عنوان مثال 'urn:x-cast:com.example.namespace'.
شنونده	تابع (رشته، رشته) شنونده برای اضافه کردن.

addUpdateListener

addUpdateListener(شنونده)

شنونده ای اضافه می کند که با تغییر Session فراخوانی می شود. تغییرات در ویژگی های زیر شنونده را فعال می کند: statusText، فضاهای نام، وضعیت، و میزان صدای گیرنده.

شنوندگان باید ویژگی status Session را برای تعیین وضعیت اتصال آن بررسی کنند. پارامتر بولی isAlive به نفع ویژگی status Session منسوخ شده است. پارامتر isAlive همچنان برای سازگاری به عقب ارسال می شود و درست است مگر اینکه status = chrome.cast.SessionStatus.STOPPED .

پارامتر
شنونده	تابع (بولی) شنونده برای اضافه کردن.

getDialAppInfo

getDialAppInfo (successCallback، error Callback)

اطلاعات برنامه DIAL را دریافت می کند.

پارامتر
موفقیت تماس برگشتی	تابع (غیر تهی chrome.cast.DialLaunchData)
errorCallback	تابع (غیر تهی chrome.cast. خطا )

ترک کردن

ترک (موفقیت پاسخ تماس، خطای برگشت تماس)

از برنامه گیرنده در حال اجرا مرتبط با جلسه خارج می شود (قطع می شود).

کلاینت های موجود در محدوده تعریف شده توسط AutoJoinPolicy این کلاینت قطع خواهند شد. مشتریان آینده به طور خودکار به جلسه ای که باقی مانده است ملحق نمی شوند.

تمام کلاینت‌های قطع شده، شنوندگان به‌روزرسانی جلسه خود را با isAlive = true فراخوانی می‌کنند. شنوندگان باید ویژگی status Session را بررسی کنند تا وضعیت اتصال آن را تعیین کنند زیرا isAlive منسوخ شده است. در این مورد، status = chrome.cast.SessionStatus.DISCONNECTED .

پارامتر
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

loadMedia

loadMedia (loadRequest، successCallback، errorCallback)

رسانه را در یک برنامه گیرنده در حال اجرا بارگذاری می کند.

پارامتر
loadRequest	chrome.cast.media.LoadRequest درخواست بارگیری رسانه مقدار نباید صفر باشد.
موفقیت تماس برگشتی	تابع (غیر تهی chrome.cast.media.Media ) در موفقیت با رسانه بارگذاری شده فراخوانی شد.
errorCallback	تابع (غیر تهی chrome.cast. خطا ) بر روی خطا احضار شد. خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

queueLoad

queueLoad (queueLoadRequest، successCallback، errorCallback)

پخش یک صف جدید از آیتم های رسانه را در یک برنامه گیرنده در حال اجرا بارگیری می کند و به صورت اختیاری شروع می کند.

پارامتر
queueLoadRequest	chrome.cast.media.QueueLoadRequest درخواست بارگیری یک صف جدید از موارد رسانه. مقدار نباید صفر باشد.
موفقیت تماس برگشتی	تابع (غیر تهی chrome.cast.media.Media ) در موفقیت با رسانه بارگذاری شده فراخوانی شد.
errorCallback	تابع (غیر تهی chrome.cast. خطا ) بر روی خطا احضار شد. خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

منسوخ

از cast.framework.CastSession#loadMedia استفاده کنید و chrome.cast.media.LoadRequest#queueData مربوطه را ارائه دهید.

removeMediaListener

removeMediaListener(شنونده)

شنونده ای را که قبلاً با addMediaListener اضافه شده بود حذف می کند.

پارامتر
شنونده	تابع (غیر تهی chrome.cast.media.Media ) شنونده برای حذف.

removeMessageListener

removeMessageListener (فضای نام، شنونده)

شنونده ای را که قبلاً برای پیام ها اضافه شده است حذف می کند.

پارامتر
فضای نام	رشته فضای نامی که به آن گوش داده می شود، به عنوان مثال 'urn:x-cast:com.example.namespace'.
شنونده	تابع (رشته، رشته) شنونده برای حذف.

removeUpdateListener

removeUpdateListener(شنونده)

شنونده ای را که قبلاً برای این جلسه اضافه شده است حذف می کند.

پارامتر
شنونده	تابع (بولی) شنونده برای حذف.

پیام فرستادن

sendMessage (فضای نام، پیام، موفقیت تماس، پاسخ به خطا)

پیامی را به برنامه گیرنده در فضای نام داده شده ارسال می کند. موفقیت تماس زمانی فراخوانی می شود که پیام به کانال پیام ارسال شود. تحویل به برنامه گیرنده بهترین تلاش است و تضمینی نیست.

پارامتر
فضای نام	رشته فضای نام برای ارسال پیام، به عنوان مثال 'urn:x-cast:com.example.namespace'.
پیام	(شیء یا رشته غیر تهی)
موفقیت تماس برگشتی	تابع() هنگام ارسال پیام فراخوانی می شود.
errorCallback	تابع (غیر تهی chrome.cast. خطا ) بر روی خطا احضار شد. خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

setReceiver Muted

setReceiverMuted (بی‌صدا، موفقیت‌آمیز، برگشت به تماس، خطای تماس)

صدای گیرنده را تنظیم می کند.

پارامتر
خاموش	بولی وضعیت جدید بی‌صدا.
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

setReceiverVolumeLevel

setReceiverVolumeLevel (سطح جدید، پاسخ به پاسخ موفقیت آمیز، پاسخ به تماس خطا)

صدای گیرنده را تنظیم می کند.

پارامتر
سطح جدید	عدد سطح صدای جدید بین 0.0 و 1.0.
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، INVALID_PARAMETER، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.

متوقف کردن

توقف (موفقیت پاسخ تماس، خطای پاسخ تماس)

برنامه گیرنده در حال اجرا مرتبط با جلسه را متوقف می کند.

پارامتر
موفقیت تماس برگشتی	تابع()
errorCallback	تابع (غیر تهی chrome.cast. خطا ) خطاهای احتمالی عبارتند از TIMEOUT، API_NOT_INITIALIZED، CHANNEL_ERROR، SESSION_ERROR، و EXTENSION_MISSING.