SFBLoopableRegionDecoder


@interface SFBLoopableRegionDecoder : NSObject <SFBPCMDecoding>

A class supporting a repeating segment of a decoder

  • Unavailable

    Undocumented

    Declaration

    Objective-C

    + (instancetype)new NS_UNAVAILABLE;
  • Unavailable

    Undocumented

    Declaration

    Objective-C

    - (instancetype)init NS_UNAVAILABLE;
  • Returns an initialized \c SFBLoopableRegionDecoder object for the given URL or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)initWithURL:(nonnull NSURL *)url
                           framePosition:(AVAudioFramePosition)framePosition
                             frameLength:(AVAudioFramePosition)frameLength
                                   error:(NSError *_Nullable *_Nullable)error;

    Parameters

    url

    The URL

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified URL, or \c nil on failure

  • Returns an initialized \c SFBLoopableRegionDecoder object for the given URL or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)initWithURL:(nonnull NSURL *)url
                           framePosition:(AVAudioFramePosition)framePosition
                             frameLength:(AVAudioFramePosition)frameLength
                             repeatCount:(NSInteger)repeatCount
                                   error:(NSError *_Nullable *_Nullable)error;

    Parameters

    url

    The URL

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    repeatCount

    The number of times to repeat

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified URL, or \c nil on failure

  • Returns an initialized \c SFBLoopableRegionDecoder object for the given input source or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)
        initWithInputSource:(nonnull SFBInputSource *)inputSource
              framePosition:(AVAudioFramePosition)framePosition
                frameLength:(AVAudioFramePosition)frameLength
                      error:(NSError *_Nullable *_Nullable)error;

    Parameters

    inputSource

    The input source

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified input source, or \c nil on failure

  • Returns an initialized \c SFBLoopableRegionDecoder object for the given input source or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)
        initWithInputSource:(nonnull SFBInputSource *)inputSource
              framePosition:(AVAudioFramePosition)framePosition
                frameLength:(AVAudioFramePosition)frameLength
                repeatCount:(NSInteger)repeatCount
                      error:(NSError *_Nullable *_Nullable)error;

    Parameters

    inputSource

    The input source

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    repeatCount

    The number of times to repeat

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified input source, or \c nil on failure

  • Returns an initialized \c SFBLoopableRegionDecoder object for the given decoder or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)initWithDecoder:(nonnull id<SFBPCMDecoding>)decoder
                               framePosition:(AVAudioFramePosition)framePosition
                                 frameLength:(AVAudioFramePosition)frameLength
                                       error:(NSError *_Nullable *_Nullable)error;

    Parameters

    decoder

    The decoder

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified decoder, or \c nil on failure

  • Returns an initialized \c SFBLoopableRegionDecoder object for the given decoder or \c nil on failure

    Declaration

    Objective-C

    - (nullable instancetype)initWithDecoder:(nonnull id<SFBPCMDecoding>)decoder
                               framePosition:(AVAudioFramePosition)framePosition
                                 frameLength:(AVAudioFramePosition)frameLength
                                 repeatCount:(NSInteger)repeatCount
                                       error:(NSError *_Nullable *_Nullable)error;

    Parameters

    decoder

    The decoder

    framePosition

    The starting frame position

    frameLength

    The number of frames to play

    repeatCount

    The number of times to repeat

    error

    An optional pointer to a \c NSError to receive error information

    Return Value

    An initialized \c SFBLoopableRegionDecoder object for the specified decoder, or \c nil on failure