Replay

@objc(GSReplay)
public protocol Replay : Stream

Base replay stream interface.

  • Current playback state.

    Declaration

    Swift

    var playState: ReplayPlayState { get }

  • Request playback to start.

    The stream is started if necessary.

    Declaration

    Swift

    func play() -> Bool

    Return Value

    ‘true’ if playback request was sent, otherwise ‘false’

  • Request playback to pause.

    The stream is started if necessary.

    Declaration

    Swift

    func pause() -> Bool

    Return Value

    ‘true’ if playback request was sent, otherwise ‘false’

  • Stop the stream.

    Declaration

    Swift

    func stop()

  • Request playback position change.

    Declaration

    Swift

    func seekTo(position: TimeInterval) -> Bool

    Parameters

    position

    time position to seek to, in seconds

    Return Value

    ‘true’ if seek request was sent, otherwise ‘false’

  • Total playback duration, in seconds.

    Declaration

    Swift

    var duration: TimeInterval { get }

  • Current playback time position, in seconds

    Note

    Position changes are NOT notified through any registered observer of that stream. The application may poll this value at the appropriate rate, depending on its use case.

    Declaration

    Swift

    var position: TimeInterval { get }