git.sesse.net Git - vlc/blob - projects/macosx/framework/Headers/Public/VLCMediaPlayer.h

   1 /*****************************************************************************
   2  * VLCMediaPlayer.h: VLCKit.framework VLCMediaPlayer header
   3  *****************************************************************************
   4  * Copyright (C) 2007-2009 Pierre d'Herbemont
   5  * Copyright (C) 2007-2009 the VideoLAN team
   6  * Partial Copyright (C) 2009 Felix Paul Kühne
   7  * $Id$
   8  *
   9  * Authors: Pierre d'Herbemont <pdherbemont # videolan.org>
  10  *          Felix Paul Kühne <fkuehne # videolan.org>
  11  *
  12  * This program is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  25  *****************************************************************************/
  26
  27 #import "VLCMedia.h"
  28 #import "VLCVideoView.h"
  29 #import "VLCVideoLayer.h"
  30 #import "VLCTime.h"
  31 #import "VLCAudio.h"
  32
  33 /* Notification Messages */
  34 extern NSString * VLCMediaPlayerTimeChanged;
  35 extern NSString * VLCMediaPlayerStateChanged;
  36
  37 /**
  38  * VLCMediaPlayerState describes the state of the media player.
  39  */
  40 typedef enum VLCMediaPlayerState
  41 {
  42     VLCMediaPlayerStateStopped,        //< Player has stopped
  43     VLCMediaPlayerStateOpening,        //< Stream is opening
  44     VLCMediaPlayerStateBuffering,      //< Stream is buffering
  45     VLCMediaPlayerStateEnded,          //< Stream has ended
  46     VLCMediaPlayerStateError,          //< Player has generated an error
  47     VLCMediaPlayerStatePlaying,        //< Stream is playing
  48     VLCMediaPlayerStatePaused          //< Stream is paused
  49 } VLCMediaPlayerState;
  50
  51 /**
  52  * Returns the name of the player state as a string.
  53  * \param state The player state.
  54  * \return A string containing the name of state. If state is not a valid state, returns nil.
  55  */
  56 extern NSString * VLCMediaPlayerStateToString(VLCMediaPlayerState state);
  57
  58 /**
  59  * Formal protocol declaration for playback delegates.  Allows playback messages
  60  * to be trapped by delegated objects.
  61  */
  62 @protocol VLCMediaPlayerDelegate
  63 /**
  64  * Sent by the default notification center whenever the player's time has changed.
  65  * \details Discussion The value of aNotification is always an VLCMediaPlayerTimeChanged notification. You can retrieve
  66  * the VLCMediaPlayer object in question by sending object to aNotification.
  67  */
  68 - (void)mediaPlayerTimeChanged:(NSNotification *)aNotification;
  69
  70 /**
  71  * Sent by the default notification center whenever the player's state has changed.
  72  * \details Discussion The value of aNotification is always an VLCMediaPlayerStateChanged notification. You can retrieve
  73  * the VLCMediaPlayer object in question by sending object to aNotification.
  74  */
  75 - (void)mediaPlayerStateChanged:(NSNotification *)aNotification;
  76 @end
  77
  78 // TODO: Should we use medialist_player or our own flavor of media player?
  79 @interface VLCMediaPlayer : NSObject
  80 {
  81     id delegate;                        //< Object delegate
  82     void * instance;                    //  Internal
  83     VLCMedia * media;                   //< Current media being played
  84     VLCTime * cachedTime;               //< Cached time of the media being played
  85     VLCMediaPlayerState cachedState;    //< Cached state of the media being played
  86     float position;                     //< The position of the media being played
  87     id drawable;                        //< The drawable associated to this media player
  88 }
  89
  90 /* Initializers */
  91 - (id)initWithVideoView:(VLCVideoView *)aVideoView;
  92 - (id)initWithVideoLayer:(VLCVideoLayer *)aVideoLayer;
  93
  94 /* Properties */
  95 - (void)setDelegate:(id)value;
  96 - (id)delegate;
  97
  98 /* Video View Options */
  99 // TODO: Should be it's own object?
 100
 101 - (void)setVideoView:(VLCVideoView *)aVideoView;
 102 - (void)setVideoLayer:(VLCVideoLayer *)aVideoLayer;
 103
 104 @property (retain) id drawable; /* The videoView or videoLayer */
 105
 106 - (void)setVideoAspectRatio:(char *)value;
 107 - (char *)videoAspectRatio;
 108 - (void)setVideoSubTitles:(int)value;
 109 - (int)countOfVideoSubTitles;
 110 - (int)currentVideoSubTitles;
 111
 112 - (void)setVideoCropGeometry:(char *)value;
 113 - (char *)videoCropGeometry;
 114
 115 - (void)setVideoTeleText:(int)value;
 116 - (int)videoTeleText;
 117
 118 /**
 119  * Take a snapshot of the current video.
 120  *
 121  * If width AND height is 0, original size is used.
 122  * If width OR height is 0, original aspect-ratio is preserved.
 123  *
 124  * \param path the path where to save the screenshot to
 125  * \param width the snapshot's width
 126  * \param height the snapshot's height
 127  */
 128 - (void)saveVideoSnapshotAt: (NSString *)path withWidth:(NSUInteger)width andHeight:(NSUInteger)height;
 129
 130 /**
 131  * Enable or disable deinterlace filter
 132  *
 133  * \param name of deinterlace filter to use (availability depends on underlying VLC version)
 134  * \param enable boolean to enable or disable deinterlace filter
 135  */
 136 - (void)setDeinterlaceFilter: (NSString *)name enabled: (BOOL)enabled;
 137
 138 @property float rate;
 139
 140 @property (readonly) VLCAudio * audio;
 141
 142 /* Video Information */
 143 - (NSSize)videoSize;
 144 - (BOOL)hasVideoOut;
 145 - (float)framesPerSecond;
 146
 147 /**
 148  * Sets the current position (or time) of the feed.
 149  * \param value New time to set the current position to.  If time is [VLCTime nullTime], 0 is assumed.
 150  */
 151 - (void)setTime:(VLCTime *)value;
 152
 153 /**
 154  * Returns the current position (or time) of the feed.
 155  * \return VLCTIme object with current time.
 156  */
 157 - (VLCTime *)time;
 158
 159 @property (readonly) VLCTime *remainingTime;
 160 @property (readonly) int fps;
 161
 162 - (void)setChapter:(int)value;
 163 - (int)currentChapter;
 164 - (int)countOfChapters;
 165
 166 - (void)setCurrentTitle:(int)value;
 167 - (int)currentTitle;
 168 - (int)countOfTitles;
 169
 170 /* Audio Options */
 171 - (void)setAudioTrack:(int)value;
 172 - (int)currentAudioTrack;
 173 - (int)countOfAudioTracks;
 174
 175 - (void)setAudioChannel:(int)value;
 176 - (int)audioChannel;
 177
 178 /* Media Options */
 179 - (void)setMedia:(VLCMedia *)value;
 180 - (VLCMedia *)media;
 181
 182 /* Playback Operations */
 183 /**
 184  * Plays a media resource using the currently selected media controller (or
 185  * default controller.  If feed was paused then the feed resumes at the position
 186  * it was paused in.
 187  * \return A Boolean determining whether the stream was played or not.
 188  */
 189 - (BOOL)play;
 190
 191 /**
 192  * Toggle's the pause state of the feed.
 193  */
 194 - (void)pause;
 195
 196 /**
 197  * Stop the playing.
 198  */
 199 - (void)stop;
 200
 201 /**
 202  * Fast forwards through the feed at the standard 1x rate.
 203  */
 204 - (void)fastForward;
 205
 206 /**
 207  * Fast forwards through the feed at the rate specified.
 208  * \param rate Rate at which the feed should be fast forwarded.
 209  */
 210 - (void)fastForwardAtRate:(float)rate;
 211
 212 /**
 213  * Rewinds through the feed at the standard 1x rate.
 214  */
 215 - (void)rewind;
 216
 217 /**
 218  * Rewinds through the feed at the rate specified.
 219  * \param rate Rate at which the feed should be fast rewound.
 220  */
 221 - (void)rewindAtRate:(float)rate;
 222
 223 /**
 224  * Jumps shortly backward in current stream if seeking is supported.
 225  * \param interval to skip, in sec.
 226  */
 227 - (void)jumpBackward:(NSInteger)interval;
 228
 229 /**
 230  * Jumps shortly forward in current stream if seeking is supported.
 231  * \param interval to skip, in sec.
 232  */
 233 - (void)jumpForward:(NSInteger)interval;
 234
 235 /**
 236  * Jumps shortly backward in current stream if seeking is supported.
 237  */
 238 - (void)extraShortJumpBackward;
 239
 240 /**
 241  * Jumps shortly forward in current stream if seeking is supported.
 242  */
 243 - (void)extraShortJumpForward;
 244
 245 /**
 246  * Jumps shortly backward in current stream if seeking is supported.
 247  */
 248 - (void)shortJumpBackward;
 249
 250 /**
 251  * Jumps shortly forward in current stream if seeking is supported.
 252  */
 253 - (void)shortJumpForward;
 254
 255 /**
 256  * Jumps shortly backward in current stream if seeking is supported.
 257  */
 258 - (void)mediumJumpBackward;
 259
 260 /**
 261  * Jumps shortly forward in current stream if seeking is supported.
 262  */
 263 - (void)mediumJumpForward;
 264
 265 /**
 266  * Jumps shortly backward in current stream if seeking is supported.
 267  */
 268 - (void)longJumpBackward;
 269
 270 /**
 271  * Jumps shortly forward in current stream if seeking is supported.
 272  */
 273 - (void)longJumpForward;
 274
 275 /* Playback Information */
 276 /**
 277  * Playback state flag identifying that the stream is currently playing.
 278  * \return TRUE if the feed is playing, FALSE if otherwise.
 279  */
 280 - (BOOL)isPlaying;
 281
 282 /**
 283  * Playback state flag identifying wheather the stream will play.
 284  * \return TRUE if the feed is ready for playback, FALSE if otherwise.
 285  */
 286 - (BOOL)willPlay;
 287
 288 /**
 289  * Playback's current state.
 290  * \see VLCMediaState
 291  */
 292 - (VLCMediaPlayerState)state;
 293
 294 /**
 295  * Returns the receiver's position in the reading.
 296  * \return A number between 0 and 1. indicating the position
 297  */
 298 - (float)position;
 299 - (void)setPosition:(float)newPosition;
 300
 301 - (BOOL)isSeekable;
 302
 303 - (BOOL)canPause;
 304
 305 @end