VLCPlaybackController.h 5.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139
  1. /*****************************************************************************
  2. * VLCPlaybackController.h
  3. * VLC for iOS
  4. *****************************************************************************
  5. * Copyright (c) 2013-2015 VideoLAN. All rights reserved.
  6. * $Id$
  7. *
  8. * Authors: Felix Paul Kühne <fkuehne # videolan.org>
  9. * Tobias Conradi <videolan # tobias-conradi.de>
  10. *
  11. * Refer to the COPYING file of the official project for license.
  12. *****************************************************************************/
  13. #import "VLCEqualizerView.h"
  14. extern NSString *const VLCPlaybackControllerPlaybackDidStart;
  15. extern NSString *const VLCPlaybackControllerPlaybackDidPause;
  16. extern NSString *const VLCPlaybackControllerPlaybackDidResume;
  17. extern NSString *const VLCPlaybackControllerPlaybackDidStop;
  18. extern NSString *const VLCPlaybackControllerPlaybackDidFail;
  19. extern NSString *const VLCPlaybackControllerPlaybackMetadataDidChange;
  20. extern NSString *const VLCPlaybackControllerPlaybackPositionUpdated;
  21. @class VLCPlaybackController;
  22. @class VLCMetaData;
  23. @protocol VLCPlaybackControllerDelegate <NSObject>
  24. @optional
  25. - (void)playbackPositionUpdated:(VLCPlaybackController *)controller;
  26. - (void)mediaPlayerStateChanged:(VLCMediaPlayerState)currentState
  27. isPlaying:(BOOL)isPlaying
  28. currentMediaHasTrackToChooseFrom:(BOOL)currentMediaHasTrackToChooseFrom
  29. currentMediaHasChapters:(BOOL)currentMediaHasChapters
  30. forPlaybackController:(VLCPlaybackController *)controller;
  31. - (void)prepareForMediaPlayback:(VLCPlaybackController *)controller;
  32. - (void)showStatusMessage:(NSString *)statusMessage forPlaybackController:(VLCPlaybackController *)controller;
  33. - (void)displayMetadataForPlaybackController:(VLCPlaybackController *)controller metadata:(VLCMetaData *)metadata;
  34. @end
  35. @interface VLCPlaybackController : NSObject <VLCEqualizerViewDelegate>
  36. @property (nonatomic, strong) UIView *videoOutputView;
  37. @property (nonatomic, strong) NSURL *successCallback;
  38. @property (nonatomic, strong) NSURL *errorCallback;
  39. @property (nonatomic, retain) VLCMediaList *mediaList;
  40. /* returns nil if currently playing item is not available,*/
  41. @property (nonatomic, strong, readonly) VLCMedia *currentlyPlayingMedia;
  42. @property (nonatomic, weak) id<VLCPlaybackControllerDelegate> delegate;
  43. @property (nonatomic, readonly) VLCMediaPlayerState mediaPlayerState;
  44. @property (nonatomic, readonly) VLCMetaData *metadata;
  45. @property (nonatomic, readonly) NSInteger mediaDuration;
  46. @property (nonatomic, readonly) BOOL isPlaying;
  47. @property (nonatomic, readonly) BOOL willPlay;
  48. @property (nonatomic, readwrite) VLCRepeatMode repeatMode;
  49. @property (nonatomic, assign, getter=isShuffleMode) BOOL shuffleMode;
  50. @property (nonatomic, readwrite) float playbackRate; // default = 1.0
  51. @property (nonatomic, readwrite) float audioDelay; // in milliseconds, default = 0.0
  52. @property (nonatomic, readwrite) float playbackPosition; // in seconds, default = 0.0
  53. @property (nonatomic, readwrite) float subtitleDelay; // in milliseconds, default = 0.0
  54. @property (nonatomic, readwrite) float hue; // default = 0.0
  55. @property (nonatomic, readwrite) float contrast; // default = 1.0
  56. @property (nonatomic, readwrite) float brightness; // default = 1.0
  57. @property (nonatomic, readwrite) float saturation; // default = 1.0
  58. @property (nonatomic, readwrite) float gamma; // default = 1.0
  59. @property (nonatomic, readonly) CGFloat yaw; // between ]-180;180]
  60. @property (nonatomic, readonly) CGFloat pitch; // ]-90;90]
  61. @property (nonatomic, readonly) CGFloat roll; // ]-180;180]
  62. @property (nonatomic, readonly) CGFloat fov; // ]0;180[ (default 80.)
  63. @property (readonly) NSInteger indexOfCurrentAudioTrack;
  64. @property (readonly) NSInteger indexOfCurrentSubtitleTrack;
  65. @property (readonly) NSInteger indexOfCurrentTitle;
  66. @property (readonly) NSInteger indexOfCurrentChapter;
  67. @property (readonly) NSInteger numberOfAudioTracks;
  68. @property (readonly) NSInteger numberOfVideoSubtitlesIndexes;
  69. @property (readonly) NSInteger numberOfTitles;
  70. @property (readonly) NSInteger numberOfChaptersForCurrentTitle;
  71. @property (assign, readonly) BOOL currentMediaHasTrackToChooseFrom;
  72. @property (assign, readwrite) BOOL fullscreenSessionRequested;
  73. @property (assign, readonly) BOOL isSeekable;
  74. @property (assign, readonly) BOOL currentMediaIs360Video;
  75. @property (readonly) NSNumber *playbackTime;
  76. @property (nonatomic, readonly) NSDictionary *mediaOptionsDictionary;
  77. @property (nonatomic, readonly) NSTimer *sleepTimer;
  78. @property (nonatomic) VLCRendererItem *renderer;
  79. + (VLCPlaybackController *)sharedInstance;
  80. - (VLCTime *)playedTime;
  81. #pragma mark - playback
  82. - (void)startPlayback;
  83. - (void)stopPlayback;
  84. - (void)playPause;
  85. - (void)play;
  86. - (void)pause;
  87. - (void)next;
  88. - (void)previous;
  89. - (void)jumpForward:(int)interval;
  90. - (void)jumpBackward:(int)interval;
  91. - (void)toggleRepeatMode;
  92. - (void)resetFilters;
  93. - (VLCTime *)remainingTime;
  94. - (NSString *)audioTrackNameAtIndex:(NSInteger)index;
  95. - (NSString *)videoSubtitleNameAtIndex:(NSInteger)index;
  96. - (NSDictionary *)titleDescriptionsDictAtIndex:(NSInteger)index;
  97. - (NSDictionary *)chapterDescriptionsDictAtIndex:(NSInteger)index;
  98. - (void)selectAudioTrackAtIndex:(NSInteger)index;
  99. - (void)selectVideoSubtitleAtIndex:(NSInteger)index;
  100. - (void)selectTitleAtIndex:(NSInteger)index;
  101. - (void)selectChapterAtIndex:(NSInteger)index;
  102. - (void)setAudioPassthrough:(BOOL)shouldPass;
  103. - (void)switchAspectRatio;
  104. - (void)switchIPhoneXFullScreen;
  105. #if !TARGET_OS_TV
  106. - (BOOL)updateViewpoint:(CGFloat)yaw pitch:(CGFloat)pitch roll:(CGFloat)roll fov:(CGFloat)fov absolute:(BOOL)absolute;
  107. - (NSInteger)currentMediaProjection;
  108. #endif
  109. - (void)recoverDisplayedMetadata;
  110. - (void)recoverPlaybackState;
  111. - (void)setNeedsMetadataUpdate;
  112. - (void)scheduleSleepTimerWithInterval:(NSTimeInterval)timeInterval;
  113. - (void)performNavigationAction:(VLCMediaPlaybackNavigationAction)action;
  114. - (void)playMediaList:(VLCMediaList *)mediaList firstIndex:(NSInteger)index subtitlesFilePath:(NSString *)subsFilePath;
  115. - (void)openVideoSubTitlesFromFile:(NSString *)pathToFile;
  116. @end