-
Notifications
You must be signed in to change notification settings - Fork 1
/
BCOVFWSessionProviderOptions.html
398 lines (212 loc) · 9.85 KB
/
BCOVFWSessionProviderOptions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>BCOVFWSessionProviderOptions Class Reference</title>
<link rel="stylesheet" href="../css/style.css">
<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
<header>
<div class="container" class="hide-in-xcode">
<h1 id="library-title">
<a href="../index.html">Brightcove Native Player for iOS </a>
</h1>
<p id="developer-home">
<a href="../index.html">Brightcove</a>
</p>
</div>
</header>
<aside>
<div class="container">
<nav>
<ul id="header-buttons" role="toolbar">
<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>
<li id="on-this-page" role="navigation">
<label>
On This Page
<div class="chevron">
<div class="chevy chevron-left"></div>
<div class="chevy chevron-right"></div>
</div>
<select id="jump-to">
<option value="top">Jump To…</option>
<option value="overview">Overview</option>
<option value="tasks">Tasks</option>
<optgroup label="Properties">
<option value="//api/name/adTimeoutInterval">adTimeoutInterval</option>
<option value="//api/name/cuePointProgressPolicy">cuePointProgressPolicy</option>
<option value="//api/name/preloadSlots">preloadSlots</option>
<option value="//api/name/timeBeforeAdToPreload">timeBeforeAdToPreload</option>
<option value="//api/name/waitForAVPlayerDuration">waitForAVPlayerDuration</option>
</optgroup>
</select>
</label>
</li>
</ul>
</nav>
</div>
</aside>
<article>
<div id="overview_contents" class="container">
<div id="content">
<main role="main">
<h1 class="title">BCOVFWSessionProviderOptions Class Reference</h1>
<div class="section section-specification"><table cellspacing="0"><tbody>
<tr>
<th>Inherits from</th>
<td>NSObject</td>
</tr><tr>
<th>Declared in</th>
<td>BCOVFWSessionProvider.h</td>
</tr>
</tbody></table></div>
<div class="section section-overview">
<a title="Overview" name="overview"></a>
<h2 class="subtitle subtitle-overview">Overview</h2>
<p>Optional configuration for FW session providers.</p>
</div>
<div class="section section-tasks">
<a title="Tasks" name="tasks"></a>
<div class="task-list">
<div class="section-method">
<a name="//api/name/waitForAVPlayerDuration" title="waitForAVPlayerDuration"></a>
<h3 class="method-title"><code><a href="#//api/name/waitForAVPlayerDuration"> waitForAVPlayerDuration</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Whether or not to wait for the AVPlayer item to report a duration before calling
the adContextPolicy. When set to NO, the duration passed into the <a href="../Blocks/BCOVFWSessionProviderAdContextPolicy.html">BCOVFWSessionProviderAdContextPolicy</a>
block may not be accurate. Defaults to Yes.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, getter=shouldWaitForAVPlayerDuration) BOOL waitForAVPlayerDuration</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Whether or not to wait for the AVPlayer item to report a duration before calling
the adContextPolicy. When set to NO, the duration passed into the <a href="../Blocks/BCOVFWSessionProviderAdContextPolicy.html">BCOVFWSessionProviderAdContextPolicy</a>
block may not be accurate. Defaults to Yes.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">BCOVFWSessionProvider.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/adTimeoutInterval" title="adTimeoutInterval"></a>
<h3 class="method-title"><code><a href="#//api/name/adTimeoutInterval"> adTimeoutInterval</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>The number of seconds the session provider will wait for an ad request
before delivering a session without using ads. Defaults to 3 seconds.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSTimeInterval adTimeoutInterval</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>The number of seconds the session provider will wait for an ad request
before delivering a session without using ads. Defaults to 3 seconds.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">BCOVFWSessionProvider.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/cuePointProgressPolicy" title="cuePointProgressPolicy"></a>
<h3 class="method-title"><code><a href="#//api/name/cuePointProgressPolicy"> cuePointProgressPolicy</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>A policy that determines whether a FreeWheel ad should be played when a
given cue point event occurs, and if so, where playback should resume.
Defaults to BCOVProgressPolicyProcessFinalCuePoint, BCOVProgressPolicyResumeFromContentPlayhead, YES.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, strong) BCOVCuePointProgressPolicy *cuePointProgressPolicy</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>A policy that determines whether a FreeWheel ad should be played when a
given cue point event occurs, and if so, where playback should resume.
Defaults to BCOVProgressPolicyProcessFinalCuePoint, BCOVProgressPolicyResumeFromContentPlayhead, YES.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">BCOVFWSessionProvider.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/preloadSlots" title="preloadSlots"></a>
<h3 class="method-title"><code><a href="#//api/name/preloadSlots"> preloadSlots</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>Determines whether or not slots are preloaded so they are ready to play when hit.
When set to YES, preroll slots will load as soon as possible. Midrolls slots
will load X seconds before the slot is to be played, determined by <a href="#//api/name/timeBeforeAdToPreload">timeBeforeAdToPreload</a>.
Defaults to NO.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, getter=shouldPreloadSlots) BOOL preloadSlots</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>Determines whether or not slots are preloaded so they are ready to play when hit.
When set to YES, preroll slots will load as soon as possible. Midrolls slots
will load X seconds before the slot is to be played, determined by <a href="#//api/name/timeBeforeAdToPreload">timeBeforeAdToPreload</a>.
Defaults to NO.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">BCOVFWSessionProvider.h</code></p>
</div>
</div>
</div>
</div><div class="section-method">
<a name="//api/name/timeBeforeAdToPreload" title="timeBeforeAdToPreload"></a>
<h3 class="method-title"><code><a href="#//api/name/timeBeforeAdToPreload"> timeBeforeAdToPreload</a></code>
</h3>
<div class="method-info">
<div class="pointy-thing"></div>
<div class="method-info-container">
<div class="method-subsection brief-description">
<p>If slot preloading is enabled, this is the amount of seconds before the ad to
preload it. Defaults to 10 seconds.</p>
</div>
<div class="method-subsection method-declaration"><code>@property (nonatomic, assign) NSTimeInterval timeBeforeAdToPreload</code></div>
<div class="method-subsection discussion-section">
<h4 class="method-subtitle">Discussion</h4>
<p>If slot preloading is enabled, this is the amount of seconds before the ad to
preload it. Defaults to 10 seconds.</p>
</div>
<div class="method-subsection declared-in-section">
<h4 class="method-subtitle">Declared In</h4>
<p><code class="declared-in-ref">BCOVFWSessionProvider.h</code></p>
</div>
</div>
</div>
</div>
</div>
</div>
</main>
<footer>
<div class="footer-copyright">
<p class="copyright">Copyright © 2018 Brightcove. All rights reserved. Updated: 2018-10-31</p>
<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
</div>
</footer>
</div>
</div>
</article>
<script src="../js/script.js"></script>
</body>
</html>