MSFKMediaControlChannel Class Reference
| Inherits from | MSFKFlintChannel : NSObject |
| Declared in | MSFKMediaControlChannel.h MSFKMediaControlChannel.m |
Tasks
Other Methods
-
mediaStatusproperty -
– init -
– loadMedia: -
– loadMedia:autoplay: -
– loadMedia:autoplay:playPosition: -
– loadMedia:autoplay:playPosition:customData: -
– pause -
– pauseWithCustomData: -
– stop -
– stopWithCustomData: -
– play -
– playWithCustomData: -
– seekToTimeInterval: -
– seekToTimeInterval:resumeState: -
– seekToTimeInterval:resumeState:customData: -
– setStreamVolume: -
– setStreamVolume:customData: -
– setStreamMuted: -
– setStreamMuted:customData: -
– requestStatus -
– approximateStreamPosition
Other Methods
Instance Methods
approximateStreamPosition
Returns the approximate stream position as calculated from the last received stream information and the elapsed wall-time since that update.
- (NSTimeInterval)approximateStreamPositionDiscussion
Returns the approximate stream position as calculated from the last received stream information and the elapsed wall-time since that update.
Declared In
MSFKMediaControlChannel.hdidConnect
Called when this channel is added to a connected handler, or when then disconnected handler to which this channel has been added becomes connected.
- (void)didConnectDiscussion
Called when this channel is added to a connected handler, or when then disconnected handler to which this channel has been added becomes connected.
This implementation updates isConnected, so if subclasses override this method they should call through to the super implementation.
Declared In
MSFKFlintChannel.hdidDisconnect
Called when this channel is removed from a connected handler, or when then connected handler to which this channel has been added becomes disconnected.
- (void)didDisconnectDiscussion
Called when this channel is removed from a connected handler, or when then connected handler to which this channel has been added becomes disconnected.
This implementation updates isConnected, so if subclasses override this method they should call through to the super implementation.
Declared In
MSFKFlintChannel.hdidReceiveTextMessage:
Called when a text message has been received for this channel. The default implementation is a no-op.
- (void)didReceiveTextMessage:(NSString *)messageParameters
- message
The message string.
Discussion
Called when a text message has been received for this channel. The default implementation is a no-op.
Declared In
MSFKFlintChannel.hinit
Designated initializer.
- (id)initDiscussion
Designated initializer.
Declared In
MSFKMediaControlChannel.hloadMedia:
Loads, enqueues (at the end of the queue), and starts playback of a new media item.
- (NSInteger)loadMedia:(MSFKMediaInformation *)mediaInfoParameters
- mediaInfo
An object describing the media item to load.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Loads, enqueues (at the end of the queue), and starts playback of a new media item.
Declared In
MSFKMediaControlChannel.hloadMedia:autoplay:
Loads, enqueues (at the end of the queue), and optionally starts playback of a new media item.
- (NSInteger)loadMedia:(MSFKMediaInformation *)mediaInfo autoplay:(BOOL)autoplayParameters
- mediaInfo
An object describing the media item to load.
- autoplay
Whether playback should start immediately.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Loads, enqueues (at the end of the queue), and optionally starts playback of a new media item.
Declared In
MSFKMediaControlChannel.hloadMedia:autoplay:playPosition:
Loads, enqueues, and optionally starts playback of a new media item.
- (NSInteger)loadMedia:(MSFKMediaInformation *)mediaInfo autoplay:(BOOL)autoplay playPosition:(NSTimeInterval)playPositionParameters
- mediaInfo
An object describing the media item to load.
- autoplay
Whether playback should start immediately.
- playPosition
The initial playback position.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Loads, enqueues, and optionally starts playback of a new media item.
Declared In
MSFKMediaControlChannel.hloadMedia:autoplay:playPosition:customData:
Loads, enqueues, and optionally starts playback of a new media item.
- (NSInteger)loadMedia:(MSFKMediaInformation *)mediaInfo autoplay:(BOOL)autoplay playPosition:(NSTimeInterval)playPosition customData:(id)customDataParameters
- mediaInfo
An object describing the media item to load.
- autoplay
Whether playback should start immediately.
- playPosition
The initial playback position.
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Loads, enqueues, and optionally starts playback of a new media item.
Declared In
MSFKMediaControlChannel.hpause
Pauses playback of the current media item.
- (NSInteger)pauseReturn Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Pauses playback of the current media item.
Declared In
MSFKMediaControlChannel.hpauseWithCustomData:
Pauses playback of the current media item.
- (NSInteger)pauseWithCustomData:(id)customDataParameters
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Pauses playback of the current media item.
Declared In
MSFKMediaControlChannel.hplay
Begins (or resumes) playback of the current media item. Playback always begins at the beginning of the stream. Asserts if there is no current media session.
- (NSInteger)playReturn Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Begins (or resumes) playback of the current media item. Playback always begins at the beginning of the stream. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hplayWithCustomData:
Begins (or resumes) playback of the current media item. Playback always begins at the beginning of the stream. Asserts if there is no current media session.
- (NSInteger)playWithCustomData:(id)customDataParameters
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Begins (or resumes) playback of the current media item. Playback always begins at the beginning of the stream. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hrequestStatus
Requests updated media status information from the receiver. Asserts if there is no current media session.
- (NSInteger)requestStatusReturn Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Requests updated media status information from the receiver. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hseekToTimeInterval:
Seeks to a new time within the current media item.
- (NSInteger)seekToTimeInterval:(NSTimeInterval)timeIntervalParameters
- position
The new time interval from the beginning of the stream.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Seeks to a new time within the current media item.
Declared In
MSFKMediaControlChannel.hseekToTimeInterval:resumeState:
Seeks to a new position within the current media item.
- (NSInteger)seekToTimeInterval:(NSTimeInterval)position resumeState:(MSFKMediaControlChannelResumeState)resumeStateParameters
- position
The new time interval from the beginning of the stream.
- resumeState
The action to take after the seek operation has finished.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Seeks to a new position within the current media item.
Declared In
MSFKMediaControlChannel.hseekToTimeInterval:resumeState:customData:
Seeks to a new position within the current media item.
- (NSInteger)seekToTimeInterval:(NSTimeInterval)position resumeState:(MSFKMediaControlChannelResumeState)resumeState customData:(id)customDataParameters
- position
The time interval from the beginning of the stream.
- resumeState
The action to take after the seek operation has finished.
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Seeks to a new position within the current media item.
Declared In
MSFKMediaControlChannel.hsetStreamMuted:
Sets whether the stream is muted. Asserts if there is no current media session.
- (NSInteger)setStreamMuted:(BOOL)mutedParameters
- muted
Whether the stream should be muted or unmuted.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Sets whether the stream is muted. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hsetStreamMuted:customData:
Sets whether the stream is muted. Asserts if there is no current media session.
- (NSInteger)setStreamMuted:(BOOL)muted customData:(id)customDataParameters
- muted
Whether the stream should be muted or unmuted.
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Sets whether the stream is muted. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hsetStreamVolume:
Sets the stream volume. Asserts if there is no current media session.
- (NSInteger)setStreamVolume:(float)volumeParameters
- volume
The new volume, in the range [0.0 - 1.0].
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Sets the stream volume. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hsetStreamVolume:customData:
Sets the stream volume. Asserts if there is no current media session.
- (NSInteger)setStreamVolume:(float)volume customData:(id)customDataParameters
- volume
The new volume, in the range [0.0 - 1.0].
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Sets the stream volume. Asserts if there is no current media session.
Declared In
MSFKMediaControlChannel.hstop
Stops playback of the current media item.
- (NSInteger)stopReturn Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Stops playback of the current media item.
Declared In
MSFKMediaControlChannel.hstopWithCustomData:
Stops playback of the current media item.
- (NSInteger)stopWithCustomData:(id)customDataParameters
- customData
Custom application-specific data to pass along with the request.
Return Value
The request ID, or kMSFKInvalidRequestID if the message could not be sent.
Discussion
Stops playback of the current media item.
Declared In
MSFKMediaControlChannel.h