MacOSX/Framework: Implement -canPause and the various setRate related functions.
[vlc.git] / extras / MacOSX / Framework / Headers / Public / VLCMediaPlayer.h
1 /*****************************************************************************
2  * VLCMediaPlayer.h: VLC.framework VLCMediaPlayer header
3  *****************************************************************************
4  * Copyright (C) 2007 Pierre d'Herbemont
5  * Copyright (C) 2007 the VideoLAN team
6  * $Id$
7  *
8  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program; if not, write to the Free Software
22  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23  *****************************************************************************/
24
25 #import <Cocoa/Cocoa.h>
26 #import "VLCMedia.h"
27 #import "VLCVideoView.h"
28 #import "VLCVideoLayer.h"
29 #import "VLCTime.h"
30
31 /* Notification Messages */
32 extern NSString * VLCMediaPlayerTimeChanged;
33 extern NSString * VLCMediaPlayerStateChanged;
34
35 /**
36  * TODO: Documentation VLCMediaPlayerState
37  */
38 typedef enum VLCMediaPlayerState
39 {
40     VLCMediaPlayerStateStopped,        //< Player has stopped
41     VLCMediaPlayerStateOpening,        //< Stream is opening
42     VLCMediaPlayerStateBuffering,      //< Stream is buffering
43     VLCMediaPlayerStateEnded,          //< Stream has ended
44     VLCMediaPlayerStateError,          //< Player has generated an error
45     VLCMediaPlayerStatePlaying,        //< Stream is playing
46     VLCMediaPlayerStatePaused          //< Stream is paused
47 } VLCMediaPlayerState;
48
49 /**
50  * TODO: Documentation extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState)
51  */
52 extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
53
54 /**
55  * Formal protocol declaration for playback delegates.  Allows playback messages
56  * to be trapped by delegated objects.
57  */
58 @protocol VLCMediaPlayerDelegate
59 /**
60  * TODO: Documentation - [VLCMediaPlayerDelegate ]
61  */
62 - (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
63
64 /**
65  * TODO: Documentation - [VLCMediaPlayerDelegate ]
66  */
67 - (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
68 @end
69
70 // TODO: Should we use medialist_player or our own flavor of media player?
71 @interface VLCMediaPlayer : NSObject 
72 {
73     id delegate;                        //< Object delegate
74
75     void * instance;                    //  Internal
76     VLCMedia * media;                   //< Current media being played
77     VLCTime * cachedTime;
78     VLCMediaPlayerState cachedState;
79     float position;
80 }
81
82 /* Initializers */
83 - (id)initWithVideoView:(VLCVideoView *)aVideoView;
84 - (id)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer;
85
86 /* Properties */
87 - (void)setDelegate:(id)value;
88 - (id)delegate;
89
90 /* Video View Options */
91 // TODO: Should be it's own object?
92
93 - (void)setVideoView:(VLCVideoView *)aVideoView;
94 - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
95
96 - (void)setVideoAspectRatio:(char *)value;
97 - (char *)videoAspectRatio;
98 - (void)setVideoSubTitles:(int)value;
99 - (int)videoSubTitles;
100
101 - (void)setVideoCropGeometry:(char *)value;
102 - (char *)videoCropGeometry;
103
104 - (void)setVideoTeleText:(int)value;
105 - (int)videoTeleText;
106
107 @property float rate;
108
109 /* Video Information */
110 - (NSSize)videoSize;
111 - (BOOL)hasVideoOut;
112 - (float)framesPerSecond;
113
114 /**
115  * Sets the current position (or time) of the feed.
116  * \param value New time to set the current position to.  If time is [VLCTime nullTime], 0 is assumed.
117  */
118 - (void)setTime:(VLCTime *)value;
119
120 /** 
121  * Returns the current position (or time) of the feed.
122  * \return VLCTIme object with current time.
123  */
124 - (VLCTime *)time;
125
126 - (void)setChapter:(int)value;
127 - (int)chapter;
128 - (int)countOfChapters;
129
130 /* Audio Options */
131 - (void)setAudioTrack:(int)value;
132 - (int)audioTrack;
133 - (int)countOfAudioTracks;
134
135 - (void)setAudioChannel:(int)value;
136 - (int)audioChannel;
137
138 /* Media Options */
139 - (void)setMedia:(VLCMedia *)value;
140 - (VLCMedia *)media;
141
142 /* Playback Operations */
143 /**
144  * Plays a media resource using the currently selected media controller (or 
145  * default controller.  If feed was paused then the feed resumes at the position 
146  * it was paused in.
147  * \return A Boolean determining whether the stream was played or not.
148  */
149 - (BOOL)play;
150
151 /**
152  * Toggle's the pause state of the feed.
153  */
154 - (void)pause;
155
156 /**
157  * Fast forwards through the feed at the standard 1x rate.
158  */
159 - (void)fastForward;
160
161 /**
162  * Fast forwards through the feed at the rate specified.
163  * \param rate Rate at which the feed should be fast forwarded.
164  */
165 - (void)fastForwardAtRate:(float)rate;
166
167 /**
168  * Rewinds through the feed at the standard 1x rate.
169  */
170 - (void)rewind;
171
172 /**
173  * Rewinds through the feed at the rate specified.
174  * \param rate Rate at which the feed should be fast rewound.
175  */
176 - (void)rewindAtRate:(float)rate;
177
178 /* Playback Information */
179 /**
180  * Playback state flag identifying that the stream is currently playing.
181  * \return TRUE if the feed is playing, FALSE if otherwise.
182  */
183 - (BOOL)isPlaying;
184
185 /**
186  * Playback state flag identifying wheather the stream will play.
187  * \return TRUE if the feed is ready for playback, FALSE if otherwise.
188  */
189 - (BOOL)willPlay;
190
191 /**
192  * Playback's current state.
193  * \see VLCMediaState
194  */
195 - (VLCMediaPlayerState)state;
196
197 /**
198  * Returns the receiver's position in the reading. 
199  * \return A number between 0 and 1. indicating the position
200  */
201 - (float)position;
202 - (void)setPosition:(float)newPosition;
203
204 - (BOOL)isSeekable;
205
206 - (BOOL)canPause;
207
208 @end