← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/monomac/docs/en/MonoMac.AVFoundation/AVPlayerItem+Notifications.xml

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/monomac/docs/en/MonoMac.AVFoundation/AVPlayerItem+Notifications.xml
 
1
<Type Name="AVPlayerItem+Notifications" FullName="MonoMac.AVFoundation.AVPlayerItem+Notifications">
 
2
  <TypeSignature Language="C#" Value="public static class AVPlayerItem.Notifications" />
 
3
  <TypeSignature Language="ILAsm" Value=".class nested public auto ansi abstract sealed beforefieldinit AVPlayerItem/Notifications extends System.Object" />
 
4
  <AssemblyInfo>
 
5
    <AssemblyName>MonoMac</AssemblyName>
 
6
    <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
7
  </AssemblyInfo>
 
8
  <Base>
 
9
    <BaseTypeName>System.Object</BaseTypeName>
 
10
  </Base>
 
11
  <Interfaces />
 
12
  <Docs>
 
13
    <summary>
 
14
      <para>Notification posted by the <see cref="T:MonoMac.AVFoundation.AVPlayerItem" /> class.</para>
 
15
    </summary>
 
16
    <remarks>
 
17
      <para>This is a static class which contains various helper methods that allow developers to observe events posted in the iOS notification hub (<see cref="T:MonoTouch.Foundation.NSNotificationCenter" />).</para>
 
18
      <para>The methods defined in this class post events invoke the provided method or lambda with a <see cref="T:MonoTouch.Foundation.NSNotificationEventArgs" /> parameter which contains strongly typed properties for the notification arguments.</para>
 
19
    </remarks>
 
20
  </Docs>
 
21
  <Members>
 
22
    <Member MemberName="ObserveDidPlayToEndTime">
 
23
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObserveDidPlayToEndTime (EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt; handler);" />
 
24
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObserveDidPlayToEndTime(class System.EventHandler`1&lt;class MonoMac.Foundation.NSNotificationEventArgs&gt; handler) cil managed" />
 
25
      <MemberType>Method</MemberType>
 
26
      <AssemblyInfo>
 
27
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
28
      </AssemblyInfo>
 
29
      <ReturnValue>
 
30
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
31
      </ReturnValue>
 
32
      <Parameters>
 
33
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt;" />
 
34
      </Parameters>
 
35
      <Docs>
 
36
        <param name="handler">Method to invoke when the notification is posted.</param>
 
37
        <summary>Registers a method to be notified when the AVPlayerItemDidPlayToEndTimeNotification notification is posted.</summary>
 
38
        <returns>
 
39
          <para>The returned NSObject represents the registered notification.   Either call Dispose on the object to stop receiving notifications, or pass it to <see cref="M:MonoTouch.Foundation.NSNotification.RemoveObserver" /></para>
 
40
        </returns>
 
41
        <remarks>
 
42
          <para>The following example shows how you can use this method in your code</para>
 
43
          <example>
 
44
            <code lang="c#">
 
45
//
 
46
// Lambda style
 
47
//
 
48
 
 
49
// listening
 
50
notification = AVPlayerItem.Notifications.ObserveObserveDidPlayToEndTime ((sender, args) =&gt; {
 
51
    /* Access strongly typed args */
 
52
    Console.WriteLine ("Notification: {0}", args.Notification);
 
53
});
 
54
 
 
55
// To stop listening:
 
56
notification.Dispose ();
 
57
 
 
58
//
 
59
//Method style
 
60
//
 
61
NSObject notification;
 
62
void Callback (object sender, ObserveDidPlayToEndTime args)
 
63
{
 
64
    // Access strongly typed args
 
65
    Console.WriteLine ("Notification: {0}", args.Notification);
 
66
}
 
67
 
 
68
void Setup ()
 
69
{
 
70
    notification = AVPlayerItem.Notifications.ObserveObserveDidPlayToEndTime (Callback);
 
71
}
 
72
 
 
73
void Teardown ()
 
74
{
 
75
    notification.Dispose ();
 
76
}</code>
 
77
          </example>
 
78
        </remarks>
 
79
      </Docs>
 
80
    </Member>
 
81
    <Member MemberName="ObserveItemFailedToPlayToEndTime">
 
82
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObserveItemFailedToPlayToEndTime (EventHandler&lt;MonoMac.AVFoundation.AVPlayerItemErrorEventArgs&gt; handler);" />
 
83
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObserveItemFailedToPlayToEndTime(class System.EventHandler`1&lt;class MonoMac.AVFoundation.AVPlayerItemErrorEventArgs&gt; handler) cil managed" />
 
84
      <MemberType>Method</MemberType>
 
85
      <AssemblyInfo>
 
86
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
87
      </AssemblyInfo>
 
88
      <ReturnValue>
 
89
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
90
      </ReturnValue>
 
91
      <Parameters>
 
92
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.AVFoundation.AVPlayerItemErrorEventArgs&gt;" />
 
93
      </Parameters>
 
94
      <Docs>
 
95
        <param name="handler">Method to invoke when the notification is posted.</param>
 
96
        <summary>Registers a method to be notified when the AVPlayerItemFailedToPlayToEndTimeNotification notification is posted.</summary>
 
97
        <returns>
 
98
          <para>The returned NSObject represents the registered notification.   Either call Dispose on the object to stop receiving notifications, or pass it to <see cref="M:MonoTouch.Foundation.NSNotification.RemoveObserver" /></para>
 
99
        </returns>
 
100
        <remarks>
 
101
          <para>The following example shows how you can use this method in your code</para>
 
102
          <example>
 
103
            <code lang="c#">
 
104
//
 
105
// Lambda style
 
106
//
 
107
 
 
108
// listening
 
109
notification = AVPlayerItem.Notifications.ObserveObserveItemFailedToPlayToEndTime ((sender, args) =&gt; {
 
110
    /* Access strongly typed args */
 
111
    Console.WriteLine ("Notification: {0}", args.Notification);
 
112
 
 
113
    Console.WriteLine ("Error", args.Error);
 
114
});
 
115
 
 
116
// To stop listening:
 
117
notification.Dispose ();
 
118
 
 
119
//
 
120
//Method style
 
121
//
 
122
NSObject notification;
 
123
void Callback (object sender, ObserveItemFailedToPlayToEndTime args)
 
124
{
 
125
    // Access strongly typed args
 
126
    Console.WriteLine ("Notification: {0}", args.Notification);
 
127
 
 
128
    Console.WriteLine ("Error", args.Error);
 
129
}
 
130
 
 
131
void Setup ()
 
132
{
 
133
    notification = AVPlayerItem.Notifications.ObserveObserveItemFailedToPlayToEndTime (Callback);
 
134
}
 
135
 
 
136
void Teardown ()
 
137
{
 
138
    notification.Dispose ();
 
139
}</code>
 
140
          </example>
 
141
        </remarks>
 
142
      </Docs>
 
143
    </Member>
 
144
    <Member MemberName="ObserveNewAccessLogEntry">
 
145
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObserveNewAccessLogEntry (EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt; handler);" />
 
146
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObserveNewAccessLogEntry(class System.EventHandler`1&lt;class MonoMac.Foundation.NSNotificationEventArgs&gt; handler) cil managed" />
 
147
      <MemberType>Method</MemberType>
 
148
      <AssemblyInfo>
 
149
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
150
      </AssemblyInfo>
 
151
      <ReturnValue>
 
152
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
153
      </ReturnValue>
 
154
      <Parameters>
 
155
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt;" />
 
156
      </Parameters>
 
157
      <Docs>
 
158
        <param name="handler">To be added.</param>
 
159
        <summary>To be added.</summary>
 
160
        <returns>To be added.</returns>
 
161
        <remarks>To be added.</remarks>
 
162
      </Docs>
 
163
    </Member>
 
164
    <Member MemberName="ObserveNewErrorLogEntry">
 
165
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObserveNewErrorLogEntry (EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt; handler);" />
 
166
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObserveNewErrorLogEntry(class System.EventHandler`1&lt;class MonoMac.Foundation.NSNotificationEventArgs&gt; handler) cil managed" />
 
167
      <MemberType>Method</MemberType>
 
168
      <AssemblyInfo>
 
169
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
170
      </AssemblyInfo>
 
171
      <ReturnValue>
 
172
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
173
      </ReturnValue>
 
174
      <Parameters>
 
175
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt;" />
 
176
      </Parameters>
 
177
      <Docs>
 
178
        <param name="handler">To be added.</param>
 
179
        <summary>To be added.</summary>
 
180
        <returns>To be added.</returns>
 
181
        <remarks>To be added.</remarks>
 
182
      </Docs>
 
183
    </Member>
 
184
    <Member MemberName="ObservePlaybackStalled">
 
185
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObservePlaybackStalled (EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt; handler);" />
 
186
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObservePlaybackStalled(class System.EventHandler`1&lt;class MonoMac.Foundation.NSNotificationEventArgs&gt; handler) cil managed" />
 
187
      <MemberType>Method</MemberType>
 
188
      <AssemblyInfo>
 
189
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
190
      </AssemblyInfo>
 
191
      <ReturnValue>
 
192
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
193
      </ReturnValue>
 
194
      <Parameters>
 
195
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt;" />
 
196
      </Parameters>
 
197
      <Docs>
 
198
        <param name="handler">To be added.</param>
 
199
        <summary>To be added.</summary>
 
200
        <returns>To be added.</returns>
 
201
        <remarks>To be added.</remarks>
 
202
      </Docs>
 
203
    </Member>
 
204
    <Member MemberName="ObserveTimeJumped">
 
205
      <MemberSignature Language="C#" Value="public static MonoMac.Foundation.NSObject ObserveTimeJumped (EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt; handler);" />
 
206
      <MemberSignature Language="ILAsm" Value=".method public static hidebysig class MonoMac.Foundation.NSObject ObserveTimeJumped(class System.EventHandler`1&lt;class MonoMac.Foundation.NSNotificationEventArgs&gt; handler) cil managed" />
 
207
      <MemberType>Method</MemberType>
 
208
      <AssemblyInfo>
 
209
        <AssemblyVersion>0.0.0.0</AssemblyVersion>
 
210
      </AssemblyInfo>
 
211
      <ReturnValue>
 
212
        <ReturnType>MonoMac.Foundation.NSObject</ReturnType>
 
213
      </ReturnValue>
 
214
      <Parameters>
 
215
        <Parameter Name="handler" Type="System.EventHandler&lt;MonoMac.Foundation.NSNotificationEventArgs&gt;" />
 
216
      </Parameters>
 
217
      <Docs>
 
218
        <param name="handler">Method to invoke when the notification is posted.</param>
 
219
        <summary>Registers a method to be notified when the AVPlayerItemTimeJumpedNotification notification is posted.</summary>
 
220
        <returns>
 
221
          <para>The returned NSObject represents the registered notification.   Either call Dispose on the object to stop receiving notifications, or pass it to <see cref="M:MonoTouch.Foundation.NSNotification.RemoveObserver" /></para>
 
222
        </returns>
 
223
        <remarks>
 
224
          <para>The following example shows how you can use this method in your code</para>
 
225
          <example>
 
226
            <code lang="c#">
 
227
//
 
228
// Lambda style
 
229
//
 
230
 
 
231
// listening
 
232
notification = AVPlayerItem.Notifications.ObserveObserveTimeJumped ((sender, args) =&gt; {
 
233
    /* Access strongly typed args */
 
234
    Console.WriteLine ("Notification: {0}", args.Notification);
 
235
});
 
236
 
 
237
// To stop listening:
 
238
notification.Dispose ();
 
239
 
 
240
//
 
241
//Method style
 
242
//
 
243
NSObject notification;
 
244
void Callback (object sender, ObserveTimeJumped args)
 
245
{
 
246
    // Access strongly typed args
 
247
    Console.WriteLine ("Notification: {0}", args.Notification);
 
248
}
 
249
 
 
250
void Setup ()
 
251
{
 
252
    notification = AVPlayerItem.Notifications.ObserveObserveTimeJumped (Callback);
 
253
}
 
254
 
 
255
void Teardown ()
 
256
{
 
257
    notification.Dispose ();
 
258
}</code>
 
259
          </example>
 
260
        </remarks>
 
261
      </Docs>
 
262
    </Member>
 
263
  </Members>
 
264
</Type>