flutter_cast_framework_modern/doc/api/cast/cast-library.html
2022-07-31 18:36:58 +02:00

421 lines
13 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, height=device-height, initial-scale=1, user-scalable=no">
<meta name="description" content="cast library API docs, for the Dart programming language.">
<title>cast library - Dart API</title>
<link rel="preconnect" href="https://fonts.gstatic.com">
<link href="https://fonts.googleapis.com/css2?family=Roboto+Mono:ital,wght@0,300;0,400;0,500;0,700;1,400&display=swap" rel="stylesheet">
<link href="https://fonts.googleapis.com/icon?family=Material+Icons" rel="stylesheet">
<link rel="stylesheet" href="../static-assets/github.css?v1">
<link rel="stylesheet" href="../static-assets/styles.css?v1">
<link rel="icon" href="../static-assets/favicon.png?v1">
</head>
<body data-base-href="../"
data-using-base-href="false">
<div id="overlay-under-drawer"></div>
<header id="title">
<button id="sidenav-left-toggle" type="button">&nbsp;</button>
<ol class="breadcrumbs gt-separated dark hidden-xs">
<li><a href="../index.html">flutter_cast_framework</a></li>
<li class="self-crumb">cast library</li>
</ol>
<div class="self-name">cast</div>
<form class="search navbar-right" role="search">
<input type="text" id="search-box" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<main>
<div id="dartdoc-main-content" class="main-content">
<div>
<h1><span class="kind-library">cast</span> library
<a href="https://dart.dev/null-safety" class="feature feature-null-safety" title="Supports the null safety language feature.">Null safety</a>
</h1></div>
<section class="summary offset-anchor" id="classes">
<h2>Classes</h2>
<dl>
<dt id="AdBreakClipInfo">
<span class="name "><a href="../cast/AdBreakClipInfo-class.html">AdBreakClipInfo</a></span>
</dt>
<dd>
</dd>
<dt id="AdBreakStatus">
<span class="name "><a href="../cast/AdBreakStatus-class.html">AdBreakStatus</a></span>
</dt>
<dd>
</dd>
<dt id="CastContext">
<span class="name "><a href="../cast/CastContext-class.html">CastContext</a></span>
</dt>
<dd>
Class wrapping the global context fot the Cast SDK
</dd>
<dt id="CastDevice">
<span class="name "><a href="../cast/CastDevice-class.html">CastDevice</a></span>
</dt>
<dd>
</dd>
<dt id="CastMessage">
<span class="name "><a href="../cast/CastMessage-class.html">CastMessage</a></span>
</dt>
<dd>
</dd>
<dt id="FlutterCastFramework">
<span class="name "><a href="../cast/FlutterCastFramework-class.html">FlutterCastFramework</a></span>
</dt>
<dd>
Entrypoint for the Flutter Cast Framework
</dd>
<dt id="MediaInfo">
<span class="name "><a href="../cast/MediaInfo-class.html">MediaInfo</a></span>
</dt>
<dd>
</dd>
<dt id="MediaLoadRequestData">
<span class="name "><a href="../cast/MediaLoadRequestData-class.html">MediaLoadRequestData</a></span>
</dt>
<dd>
</dd>
<dt id="MediaMetadata">
<span class="name "><a href="../cast/MediaMetadata-class.html">MediaMetadata</a></span>
</dt>
<dd>
</dd>
<dt id="MediaQueueItem">
<span class="name "><a href="../cast/MediaQueueItem-class.html">MediaQueueItem</a></span>
</dt>
<dd>
</dd>
<dt id="MediaStatus">
<span class="name "><a href="../cast/MediaStatus-class.html">MediaStatus</a></span>
</dt>
<dd>
</dd>
<dt id="MediaTrack">
<span class="name "><a href="../cast/MediaTrack-class.html">MediaTrack</a></span>
</dt>
<dd>
</dd>
<dt id="ProgressInfo">
<span class="name "><a href="../cast/ProgressInfo-class.html">ProgressInfo</a></span>
</dt>
<dd>
</dd>
<dt id="RemoteMediaClient">
<span class="name "><a href="../cast/RemoteMediaClient-class.html">RemoteMediaClient</a></span>
</dt>
<dd>
Class for controlling a media player application running on a receiver.
</dd>
<dt id="SessionManager">
<span class="name "><a href="../cast/SessionManager-class.html">SessionManager</a></span>
</dt>
<dd>
A class that manages Session instances. The application can attach a
listeners to be notified of session events.
</dd>
<dt id="WebImage">
<span class="name "><a href="../cast/WebImage-class.html">WebImage</a></span>
</dt>
<dd>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="enums">
<h2>Enums</h2>
<dl>
<dt id="CastState">
<span class="name "><a href="../cast/CastState.html">CastState</a></span>
</dt>
<dd>
The possible casting states.
</dd>
<dt id="MediaMetadataKey">
<span class="name "><a href="../cast/MediaMetadataKey.html">MediaMetadataKey</a></span>
</dt>
<dd>
</dd>
<dt id="MediaType">
<span class="name "><a href="../cast/MediaType.html">MediaType</a></span>
</dt>
<dd>
</dd>
<dt id="PlayerState">
<span class="name "><a href="../cast/PlayerState.html">PlayerState</a></span>
</dt>
<dd>
</dd>
<dt id="SessionState">
<span class="name "><a href="../cast/SessionState.html">SessionState</a></span>
</dt>
<dd>
State of the session
</dd>
<dt id="StreamType">
<span class="name "><a href="../cast/StreamType.html">StreamType</a></span>
</dt>
<dd>
</dd>
<dt id="TrackSubtype">
<span class="name "><a href="../cast/TrackSubtype.html">TrackSubtype</a></span>
</dt>
<dd>
</dd>
<dt id="TrackType">
<span class="name "><a href="../cast/TrackType.html">TrackType</a></span>
</dt>
<dd>
</dd>
</dl>
</section>
<section class="summary offset-anchor" id="typedefs">
<h2>Typedefs</h2>
<dl>
<dt id="AdBreakClipProgressListener" class="callable">
<span class="name"><a href="../cast/AdBreakClipProgressListener.html">AdBreakClipProgressListener</a></span><span class="signature">
<span class="returntype parameter">= void Function<span class="signature">(<span class="parameter" id="param-adBreakId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">adBreakId</span>, </span><span class="parameter" id="param-adBreakClipId"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">adBreakClipId</span>, </span><span class="parameter" id="param-progressMs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">progressMs</span>, </span><span class="parameter" id="param-durationMs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">durationMs</span>, </span><span class="parameter" id="param-whenSkippableMs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">whenSkippableMs</span></span>)</span></span>
</span>
</dt>
<dd>
</dd>
<dt id="MediaStatusListener" class="callable">
<span class="name"><a href="../cast/MediaStatusListener.html">MediaStatusListener</a></span><span class="signature">
<span class="returntype parameter">= void Function<span class="signature">(<span class="parameter" id="param-mediaStatus"><span class="type-annotation"><a href="../cast/MediaStatus-class.html">MediaStatus</a></span> <span class="parameter-name">mediaStatus</span></span>)</span></span>
</span>
</dt>
<dd>
</dd>
<dt id="MessageReceivedCallback" class="callable">
<span class="name"><a href="../cast/MessageReceivedCallback.html">MessageReceivedCallback</a></span><span class="signature">
<span class="returntype parameter">= void Function<span class="signature">(<span class="parameter" id="param-namespace"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">namespace</span>, </span><span class="parameter" id="param-message"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/String-class.html">String</a></span> <span class="parameter-name">message</span></span>)</span></span>
</span>
</dt>
<dd>
</dd>
<dt id="ProgressListener" class="callable">
<span class="name"><a href="../cast/ProgressListener.html">ProgressListener</a></span><span class="signature">
<span class="returntype parameter">= void Function<span class="signature">(<span class="parameter" id="param-progressMs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">progressMs</span>, </span><span class="parameter" id="param-durationMs"><span class="type-annotation"><a href="https://api.flutter.dev/flutter/dart-core/int-class.html">int</a></span> <span class="parameter-name">durationMs</span></span>)</span></span>
</span>
</dt>
<dd>
</dd>
</dl>
</section>
</div> <!-- /.main-content -->
<div id="dartdoc-sidebar-left" class="sidebar sidebar-offcanvas-left">
<header id="header-search-sidebar" class="hidden-l">
<form class="search-sidebar" role="search">
<input type="text" id="search-sidebar" autocomplete="off" disabled class="form-control typeahead" placeholder="Loading search...">
</form>
</header>
<ol class="breadcrumbs gt-separated dark hidden-l" id="sidebar-nav">
<li><a href="../index.html">flutter_cast_framework</a></li>
<li class="self-crumb">cast library</li>
</ol>
<h5><span class="package-name">flutter_cast_framework</span> <span class="package-kind">package</span></h5>
<ol>
<li class="section-title">Libraries</li>
<li><a href="../cast/cast-library.html">cast</a></li>
<li><a href="../widgets/widgets-library.html">widgets</a></li>
</ol>
</div>
<div id="dartdoc-sidebar-right" class="sidebar sidebar-offcanvas-right">
<h5>cast library</h5>
<ol>
<li class="section-title"><a href="../cast/cast-library.html#classes">Classes</a></li>
<li><a href="../cast/AdBreakClipInfo-class.html">AdBreakClipInfo</a></li>
<li><a href="../cast/AdBreakStatus-class.html">AdBreakStatus</a></li>
<li><a href="../cast/CastContext-class.html">CastContext</a></li>
<li><a href="../cast/CastDevice-class.html">CastDevice</a></li>
<li><a href="../cast/CastMessage-class.html">CastMessage</a></li>
<li><a href="../cast/FlutterCastFramework-class.html">FlutterCastFramework</a></li>
<li><a href="../cast/MediaInfo-class.html">MediaInfo</a></li>
<li><a href="../cast/MediaLoadRequestData-class.html">MediaLoadRequestData</a></li>
<li><a href="../cast/MediaMetadata-class.html">MediaMetadata</a></li>
<li><a href="../cast/MediaQueueItem-class.html">MediaQueueItem</a></li>
<li><a href="../cast/MediaStatus-class.html">MediaStatus</a></li>
<li><a href="../cast/MediaTrack-class.html">MediaTrack</a></li>
<li><a href="../cast/ProgressInfo-class.html">ProgressInfo</a></li>
<li><a href="../cast/RemoteMediaClient-class.html">RemoteMediaClient</a></li>
<li><a href="../cast/SessionManager-class.html">SessionManager</a></li>
<li><a href="../cast/WebImage-class.html">WebImage</a></li>
<li class="section-title"><a href="../cast/cast-library.html#enums">Enums</a></li>
<li><a href="../cast/CastState.html">CastState</a></li>
<li><a href="../cast/MediaMetadataKey.html">MediaMetadataKey</a></li>
<li><a href="../cast/MediaType.html">MediaType</a></li>
<li><a href="../cast/PlayerState.html">PlayerState</a></li>
<li><a href="../cast/SessionState.html">SessionState</a></li>
<li><a href="../cast/StreamType.html">StreamType</a></li>
<li><a href="../cast/TrackSubtype.html">TrackSubtype</a></li>
<li><a href="../cast/TrackType.html">TrackType</a></li>
<li class="section-title"><a href="../cast/cast-library.html#typedefs">Typedefs</a></li>
<li><a href="../cast/AdBreakClipProgressListener.html">AdBreakClipProgressListener</a></li>
<li><a href="../cast/MediaStatusListener.html">MediaStatusListener</a></li>
<li><a href="../cast/MessageReceivedCallback.html">MessageReceivedCallback</a></li>
<li><a href="../cast/ProgressListener.html">ProgressListener</a></li>
</ol>
</div><!--/sidebar-offcanvas-right-->
</main>
<footer>
<span class="no-break">
flutter_cast_framework
0.0.1-alpha.1
</span>
</footer>
<script src="../static-assets/highlight.pack.js?v1"></script>
<script src="../static-assets/script.js?v1"></script>
</body>
</html>