#import <VLCMedia.h>
Defines files and streams as a managed object. Each media object can be administered seperately. VLCMediaPlayer or VLCMediaList must be used to execute the appropriate playback functions.
- See also
- VLCMediaPlayer
-
VLCMediaList
◆ __attribute__ [1/5]
- (BOOL isParsed) __attribute__ |
|
((deprecated)) |
|
|
Determines if the media has already been preparsed.
- Deprecated:
- use parseStatus instead
◆ __attribute__ [2/5]
- (BOOL saveMetadata) __attribute__ |
|
((deprecated)) |
|
|
Save the previously changed metadata
- Returns
- true if saving was successful
- Deprecated:
- use metaData's saving capabilities instead
◆ __attribute__ [3/5]
- (NSDictionary* metaDictionary) __attribute__ |
|
((deprecated)) |
|
|
The receiver's meta data as a NSDictionary object.
- Deprecated:
- use metaData instead
◆ __attribute__ [4/5]
- ((deprecated) __attribute__ |
|
|
|
Start asynchronously to parse the media. This will attempt to fetch the meta data and tracks information.
This is automatically done when an accessor requiring parsing is called.
- See also
- -[VLCMediaDelegate mediaDidFinishParsing:]
- Deprecated:
- Use parseWithOptions: instead
◆ __attribute__ [5/5]
- ((deprecated) __attribute__ |
|
|
|
Trigger a synchronous parsing of the media the selector won't return until parsing finished
- Deprecated:
- Use parseWithOptions: instead
◆ addOption:
- (void) addOption: |
|
(NSString *) |
option |
|
Add options to the media, that will be used to determine how VLCMediaPlayer will read the media. This allow to use VLC advanced reading/streaming options in a per-media basis
The options are detailed in vlc –long-help, for instance "--sout-all" And on the web: http://wiki.videolan.org/VLC_command-line_help
◆ clearStoredCookies
- (void) clearStoredCookies |
|
|
|
Clear the stored cookies of a media.
- Note
- must be called before the first call of play() to take effect. The cookie jar is only used for http/https.
- Warning
- This method will never succeed on macOS, but requires iOS or tvOS
◆ codecNameForFourCC:trackType:
+ (NSString *) codecNameForFourCC: |
|
(uint32_t) |
fourcc |
trackType: |
|
(NSString *) |
trackType |
|
|
| |
convienience method to return a user-readable codec name for the given FourCC
- Parameters
-
fourcc | the FourCC to process |
trackType | a VLC track type if known to speed-up the name search |
- Returns
- a NSString containing the codec name if recognized, else an empty string
◆ compare:
- (NSComparisonResult) compare: |
|
(nullable VLCMedia *) |
media |
|
Returns an NSComparisonResult value that indicates the lexical ordering of the receiver and a given meda.
- Parameters
-
media | The media with which to compare with the receiver. |
- Returns
- NSOrderedAscending if the URL of the receiver precedes media in lexical ordering, NSOrderedSame if the URL of the receiver and media are equivalent in lexical value, and NSOrderedDescending if the URL of the receiver follows media. If media is nil, returns NSOrderedDescending.
◆ DEPRECATED_MSG_ATTRIBUTE [1/16]
- (NSDictionary* stats) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
Getter for statistics information Returns a NSDictionary with NSNumbers for values.
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [2/16]
- (NSInteger numberOfReadBytesOnInput) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the number of bytes read by the current input module
- Returns
- a NSInteger with the raw number of bytes
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [3/16]
- (float inputBitrate) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the current input bitrate. may be 0 if the buffer is full
- Returns
- a float of the current input bitrate
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [4/16]
- (NSInteger numberOfReadBytesOnDemux) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the number of bytes read by the current demux module
- Returns
- a NSInteger with the raw number of bytes
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [5/16]
- (float demuxBitrate) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the current demux bitrate. may be 0 if the buffer is empty
- Returns
- a float of the current demux bitrate
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [6/16]
- (NSInteger numberOfDecodedVideoBlocks) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of decoded video blocks in the current media session
- Returns
- a NSInteger with the total number of decoded blocks
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [7/16]
- (NSInteger numberOfDecodedAudioBlocks) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of decoded audio blocks in the current media session
- Returns
- a NSInteger with the total number of decoded blocks
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [8/16]
- (NSInteger numberOfDisplayedPictures) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of displayed pictures during the current media session
- Returns
- a NSInteger with the total number of displayed pictures
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [9/16]
- (NSInteger numberOfLostPictures) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of pictures lost during the current media session
- Returns
- a NSInteger with the total number of lost pictures
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [10/16]
- (NSInteger numberOfPlayedAudioBuffers) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of played audio buffers during the current media session
- Returns
- a NSInteger with the total number of played audio buffers
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [11/16]
- (NSInteger numberOfLostAudioBuffers) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of audio buffers lost during the current media session
- Returns
- a NSInteger with the total number of displayed pictures
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [12/16]
- (NSInteger numberOfSentPackets) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of packets sent during the current media session
- Returns
- a NSInteger with the total number of sent packets
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [13/16]
- (NSInteger numberOfSentBytes) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of raw bytes sent during the current media session
- Returns
- a NSInteger with the total number of sent bytes
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [14/16]
- (float streamOutputBitrate) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the current bitrate of sent bytes
- Returns
- a float of the current bitrate of sent bits
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [15/16]
- (NSInteger numberOfCorruptedDataPackets) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of corrupted data packets during current sout session
- Note
- value is 0 on non-stream-output operations
- Returns
- a NSInteger with the total number of corrupted data packets
Provided by category VLCMedia(Deprecated).
◆ DEPRECATED_MSG_ATTRIBUTE [16/16]
- (NSInteger numberOfDiscontinuties) DEPRECATED_MSG_ATTRIBUTE |
|
("Use - instead") |
[VLCMedia statistics] |
|
returns the total number of discontinuties during current sout session
- Note
- value is 0 on non-stream-output operations
- Returns
- a NSInteger with the total number of discontinuties
Provided by category VLCMedia(Deprecated).
◆ initAsNodeWithName:
- (instancetype) initAsNodeWithName: |
|
(NSString *) |
aName |
|
TODO
- Parameters
-
- Returns
- A new VLCMedia object, only if there were no errors.
◆ initWithPath:
- (instancetype) initWithPath: |
|
(NSString *) |
aPath |
|
Initializes a new VLCMedia object to use the specified path.
- Parameters
-
aPath | Path to media to be accessed. |
- Returns
- A new VLCMedia object, only if there were no errors.
◆ initWithStream:
- (instancetype) initWithStream: |
|
(NSInputStream *) |
stream |
|
Initializes a new VLCMedia object to use an input stream.
- Note
- By default, NSStream instances that are not file-based are non-seekable, you may subclass NSInputStream whose instances are capable of seeking through a stream. This subclass must allow setting NSStreamFileCurrentOffsetKey property.
-
VLCMedia will open stream if it is not already opened, and will close eventually. You can't pass an already closed input stream.
- Parameters
-
stream | Input stream for media to be accessed. |
- Returns
- A new VLCMedia object, only if there were no errors.
◆ initWithURL:
- (instancetype) initWithURL: |
|
(NSURL *) |
anURL |
|
Initializes a new VLCMedia object to use the specified URL.
- Parameters
-
anURL | the URL to media to be accessed. |
- Returns
- A new VLCMedia object, only if there were no errors.
◆ lengthWaitUntilDate:
- (VLCTime *) lengthWaitUntilDate: |
|
(NSDate *) |
aDate |
|
Returns a VLCTime object describing the length of the media resource, however, this is a blocking operation and will wait until the preparsing is completed before returning anything.
- Parameters
-
aDate | Time for operation to wait until, if there are no results before specified date then nil is returned. |
- Returns
- The length of the media resource, nil if it couldn't wait for it.
◆ mediaAsNodeWithName:
+ (instancetype) mediaAsNodeWithName: |
|
(NSString *) |
aName |
|
TODO
- Parameters
-
- Returns
- a new VLCMedia object, only if there were no errors. This object will be automatically released.
- See also
- initAsNodeWithName
◆ mediaWithPath:
+ (instancetype) mediaWithPath: |
|
(NSString *) |
aPath |
|
Manufactures a new VLCMedia object using the path specified.
- Parameters
-
aPath | Path to the media to be accessed. |
- Returns
- A new VLCMedia object, only if there were no errors. This object will be automatically released.
- See also
- initWithPath
◆ mediaWithURL:
+ (instancetype) mediaWithURL: |
|
(NSURL *) |
anURL |
|
Manufactures a new VLCMedia object using the URL specified.
- Parameters
-
anURL | URL to media to be accessed. |
- Returns
- A new VLCMedia object, only if there were no errors. This object will be automatically released.
- See also
- initWithMediaURL
◆ metadataForKey:
- (nullable NSString *) metadataForKey: |
|
((deprecated)) |
__attribute__ |
|
get meta property for key
- Note
- for performance reasons, fetching the metaDictionary will be faster!
- See also
- metaDictionary
-
dictionary keys above
- Deprecated:
- use the metaData object instead
◆ NS_ENUM [1/4]
- (typedef) NS_ENUM |
|
(NSUInteger) |
|
|
|
(VLCMediaOrientation) |
|
|
|
| |
list of possible media orientation.
◆ NS_ENUM [2/4]
- (typedef) NS_ENUM |
|
(NSUInteger) |
|
|
|
(VLCMediaProjection) |
|
|
|
| |
list of possible media projection.
◆ NS_ENUM [3/4]
- (typedef) NS_ENUM |
|
(NSUInteger) |
|
|
|
(VLCMediaType) |
|
|
|
| |
list of possible media types that could be returned by "mediaType"
◆ NS_ENUM [4/4]
- (typedef) NS_ENUM |
|
(unsigned) |
|
|
|
(VLCMediaParsedStatus) |
|
|
|
| |
list of possible parsed states returnable by parsedStatus
◆ NS_OPTIONS
- (typedef) NS_OPTIONS |
|
(int) |
|
|
|
(VLCMediaParsingOptions) |
|
|
|
| |
enum of available options for use with parseWithOptions
- Note
- you may pipe multiple values for the single parameter
< Parse media if it's a local file
< Parse media even if it's a network file
< Fetch meta and covert art using local resources
< Fetch meta and covert art using network resources
< Interact with the user when preparsing this item (and not its sub items). Set this flag in order to receive a callback when the input is asking for credentials.
◆ parseStop
Stop the parsing of the media
When the media parsing is stopped, the mediaDidFinishParsing will be sent with the VLCMediaParsedStatusTimeout status.
◆ parseWithOptions:
- (int) parseWithOptions: |
|
(VLCMediaParsingOptions) |
options |
|
triggers an asynchronous parse of the media item using the given options
- Parameters
-
options | the option mask based on VLCMediaParsingOptions |
- See also
- VLCMediaParsingOptions
- Returns
- an int. 0 on success, -1 in case of error
- Note
- listen to the "parsed" key value or the mediaDidFinishParsing: delegate method to be notified about parsing results. Those triggers will NOT be raised if parsing fails and this method returns an error.
◆ parseWithOptions:timeout:
- (int) parseWithOptions: |
|
(VLCMediaParsingOptions) |
options |
timeout: |
|
(int) |
timeoutValue |
|
|
| |
triggers an asynchronous parse of the media item using the given options
- Parameters
-
options | the option mask based on VLCMediaParsingOptions |
timeoutValue | a time-out value in milliseconds (-1 for default, 0 for infinite) |
- See also
- VLCMediaParsingOptions
- Returns
- an int. 0 on success, -1 in case of error
- Note
- listen to the "parsed" key value or the mediaDidFinishParsing: delegate method to be notified about parsing results. Those triggers will NOT be raised if parsing fails and this method returns an error.
◆ setMetadata:forKey:
- (void) setMetadata: |
|
(NSString *) |
data |
forKey: |
|
((deprecated)) |
__attribute__ |
|
|
| |
set meta property for key
- Parameters
-
data | the metadata to set as NSString |
key | the metadata key |
- See also
- dictionary keys above
- Deprecated:
- use metaData's properties instead
◆ storeCookie:forHost:path:
- (int) storeCookie: |
|
(NSString *) |
cookie |
forHost: |
|
(NSString *) |
host |
path: |
|
(NSString *) |
path |
|
|
| |
Parse a value of an incoming Set-Cookie header (see RFC 6265) and append the cookie to the stored cookies if appropriate. The "secure" attribute can be added to cookie to limit the scope of the cookie to secured channels (https).
- Note
- must be called before the first call of play() to take effect. The cookie storage is only used for http/https.
- Warning
- This method will never succeed on macOS, but requires iOS or tvOS
- Parameters
-
cookie | header field value of Set-Cookie: "name=value<;attributes>" |
host | host to which the cookie will be sent |
path | scope of the cookie |
- Returns
- 0 on success, -1 on error.
◆ VLCMediaTracksInformationAudioChannelsNumber
- (NSString* const) VLCMediaTracksInformationAudioChannelsNumber |
number of audio channels of a given track
- Note
- returns the audio channel number as NSNumber
◆ VLCMediaTracksInformationAudioRate
- (NSString* const) VLCMediaTracksInformationAudioRate |
audio rate
- Note
- returns the audio rate as NSNumber
◆ VLCMediaTracksInformationBitrate
- (NSString* const) VLCMediaTracksInformationBitrate |
track bitrate
- Note
- returns the bitrate as NSNumber
◆ VLCMediaTracksInformationCodec
- (NSString* const) VLCMediaTracksInformationCodec |
Tracks information NSDictionary Possible Keys Codec information
- Note
- returns a NSNumber
◆ VLCMediaTracksInformationCodecLevel
- (NSString* const) VLCMediaTracksInformationCodecLevel |
codec level
- Note
- returns a NSNumber
◆ VLCMediaTracksInformationCodecProfile
- (NSString* const) VLCMediaTracksInformationCodecProfile |
codec profile
- Note
- returns a NSNumber
◆ VLCMediaTracksInformationDescription
- (NSString* const) VLCMediaTracksInformationDescription |
track description
- Note
- returns the description as NSString
◆ VLCMediaTracksInformationFrameRate
- (NSString* const) VLCMediaTracksInformationFrameRate |
frame rate
- Note
- returns the frame rate as NSNumber
◆ VLCMediaTracksInformationFrameRateDenominator
- (NSString* const) VLCMediaTracksInformationFrameRateDenominator |
frame rate denominator
- Note
- returns the frame rate denominator as NSNumber
◆ VLCMediaTracksInformationId
- (NSString* const) VLCMediaTracksInformationId |
tracks information ID
- Note
- returns a NSNumber
◆ VLCMediaTracksInformationLanguage
- (NSString* const) VLCMediaTracksInformationLanguage |
track language
- Note
- returns the language as NSString
◆ VLCMediaTracksInformationSourceAspectRatio
- (NSString* const) VLCMediaTracksInformationSourceAspectRatio |
source aspect ratio
- Note
- returns the source aspect ratio as NSNumber
◆ VLCMediaTracksInformationSourceAspectRatioDenominator
- (NSString* const) VLCMediaTracksInformationSourceAspectRatioDenominator |
source aspect ratio denominator
- Note
- returns the source aspect ratio denominator as NSNumber
◆ VLCMediaTracksInformationTextEncoding
- (NSString* const) VLCMediaTracksInformationTextEncoding |
text encoding
- Note
- returns the text encoding as NSString
◆ VLCMediaTracksInformationType
- (NSString* const) VLCMediaTracksInformationType |
◆ VLCMediaTracksInformationTypeAudio
- (NSString* const) VLCMediaTracksInformationTypeAudio |
audio track information NSDictionary value for VLCMediaTracksInformationType
◆ VLCMediaTracksInformationTypeText
- (NSString* const) VLCMediaTracksInformationTypeText |
text / subtitles track information NSDictionary value for VLCMediaTracksInformationType
◆ VLCMediaTracksInformationTypeUnknown
- (NSString* const) VLCMediaTracksInformationTypeUnknown |
unknown track information NSDictionary value for VLCMediaTracksInformationType
◆ VLCMediaTracksInformationTypeVideo
- (NSString* const) VLCMediaTracksInformationTypeVideo |
video track information NSDictionary value for VLCMediaTracksInformationType
◆ VLCMediaTracksInformationVideoHeight
- (NSString* const) VLCMediaTracksInformationVideoHeight |
video track height
- Note
- returns the height as NSNumber
◆ VLCMediaTracksInformationVideoOrientation
- (NSString* const) VLCMediaTracksInformationVideoOrientation |
video track orientation
- Note
- returns the orientation as NSNumber
◆ VLCMediaTracksInformationVideoProjection
- (NSString* const) VLCMediaTracksInformationVideoProjection |
video track projection
- Note
- the projection as NSNumber
◆ VLCMediaTracksInformationVideoWidth
- (NSString* const) VLCMediaTracksInformationVideoWidth |
video track width
- Note
- the width as NSNumber
◆ delegate
◆ length
A VLCTime object describing the length of the media resource, only if it is available. Use lengthWaitUntilDate: to wait for a specified length of time.
- See also
- lengthWaitUntilDate
◆ mediaSizeSuitableForDevice
- (BOOL) mediaSizeSuitableForDevice |
|
readatomicassign |
returns a bool whether is the media is expected to play fluently on this device or not. It always returns YES on a Mac.
◆ mediaType
- (VLCMediaType) mediaType |
|
readatomicassign |
media type
- Returns
- returns the type of a media (VLCMediaType)
◆ metaData
The receiver's metadata as a self-contained object
◆ parsedStatus
- (VLCMediaParsedStatus) parsedStatus |
|
readnonatomicassign |
- Returns
- Returns the parse status of the media
◆ state
The receiver's state, such as Playing, Error, NothingSpecial, Buffering.
◆ statistics
media statistics information
- Parameters:
- readBytes: the number of bytes read by the current input module.
- inputBitrate: the current input bitrate. may be 0 if the buffer is full.
- demuxReadBytes: the number of bytes read by the current demux module.
- demuxBitrate: the current demux bitrate. may be 0 if the buffer is empty.
- demuxCorrupted: the total number of corrupted data packets during current sout session. value is 0 on non-stream-output operations.
- demuxDiscontinuity: the total number of discontinuties during current sout session. value is 0 on non-stream-output operations.
- decodedVideo: the total number of decoded video blocks in the current media session.
- decodedAudio: the total number of decoded audio blocks in the current media session.
- displayedPictures: the total number of displayed pictures during the current media session.
- lostPictures: the total number of pictures lost during the current media session.
- playedAudioBuffers: the total number of played audio buffers during the current media session.
- lostAudioBuffers: the total number of audio buffers lost during the current media session.
- sentPackets: the total number of packets sent during the current media session.
- sentBytes: the total number of raw bytes sent during the current media session.
- sendBitrate: the current bitrate of sent bytes.
◆ subitems
◆ tracksInformation
- (NSArray*) tracksInformation |
|
readatomiccopy |
◆ url
The URL for the receiver's media resource.
◆ userData
userData is specialized data accessed by the host application.
The documentation for this class was generated from the following file: