FMLiveSwitchOggAudioRecorder Class Reference

An Ogg audio recorder. More...

Instance Methods

(NSString *) - artist
 Gets the file artist. More...
 
(void) - doUpdateHeader
 Updates the file header. More...
 
(void) - doWriteHeader
 Writes the file header. More...
 
(bool) - doWriteWithBuffer:presentationTimestamp:
 Write an encoded video frame. More...
 
(instancetype) - initWithPath:inputFormat:
 Initializes a new instance of the FMLiveSwitchOggAudioRecorder class. More...
 
(void) - setArtist:
 Sets the file artist. More...
 
(void) - setTitle:
 Sets the file title. More...
 
(void) - setVendor:
 Sets the file vendor. More...
 
(NSString *) - title
 Gets the file title. More...
 
(NSString *) - vendor
 Gets the file vendor. More...
 
- Instance Methods inherited from FMLiveSwitchAudioRecorder
(instancetype) - initWithPath:
 Initializes a new instance of the FMLiveSwitchAudioRecorder class. More...
 
- Instance Methods inherited from FMLiveSwitchMediaRecorder
(bool) - doWriteWithBuffer:presentationTimestamp:
 Write an encoded video frame. More...
 
(FMLiveSwitchFileStream *) - file
 Gets the file. More...
 
(FMLiveSwitchFileAssistant *) - fileStream
 Gets the recorder stream. More...
 
(TFormat) - format
 Gets the format. More...
 
(void) - open
 Opens the file and writes the initial header. More...
 
(bool) - opened
 Gets whether the recorder has been opened or not. More...
 
(NSString *) - openPath
 Gets the currently open path. More...
 
(NSString *) - path
 Gets the path. More...
 
(void) - setFile:
 Sets the file. More...
 
(void) - setFileStream:
 Sets the recorder stream. More...
 
(void) - setWasOpened:
 Sets a value indicating whether the file was opened. More...
 
(bool) - wasOpened
 Gets a value indicating whether the file was opened. More...
 
(bool) - writeWithBuffer:presentationTimestamp:
 Write an encoded video frame using the width and height parameters from the first keyframe. More...
 

Class Methods

(FMLiveSwitchOggAudioRecorder *) + audioRecorderWithPath:inputFormat:
 Initializes a new instance of the FMLiveSwitchOggAudioRecorder class. More...
 
- Class Methods inherited from FMLiveSwitchAudioRecorder
(FMLiveSwitchAudioRecorder *) + audioRecorderWithPath:
 Initializes a new instance of the FMLiveSwitchAudioRecorder class. More...
 
- Class Methods inherited from FMLiveSwitchMediaRecorder
(FMLiveSwitchMediaRecorder *) + mediaRecorderWithPath:
 Initializes a new instance of the FMLiveSwitchMediaRecorder`2 class. More...
 

Additional Inherited Members

- Protected Attributes inherited from FMLiveSwitchMediaRecorder
 __pad0__: NSObject- (void) close
 

Detailed Description

An Ogg audio recorder.

Method Documentation

◆ artist

- (NSString*) artist

Gets the file artist.

◆ audioRecorderWithPath:inputFormat:

+ (FMLiveSwitchOggAudioRecorder*) audioRecorderWithPath: (NSString *)  path
inputFormat: (FMLiveSwitchAudioFormat *)  inputFormat 

Initializes a new instance of the FMLiveSwitchOggAudioRecorder class.

Parameters
pathThe path.
inputFormatThe input format.

◆ doUpdateHeader

- (void) doUpdateHeader

Updates the file header.

Implements FMLiveSwitchMediaRecorder.

◆ doWriteHeader

- (void) doWriteHeader

Writes the file header.

Implements FMLiveSwitchMediaRecorder.

◆ doWriteWithBuffer:presentationTimestamp:

- (bool) doWriteWithBuffer: (FMLiveSwitchAudioBuffer *)  buffer
presentationTimestamp: (long long)  presentationTimestamp 

Write an encoded video frame.

Parameters
bufferThe encoded buffer.
presentationTimestampThe presentation timestamp.
Returns
true if the encoded frame was written successfully; otherwise, false

◆ initWithPath:inputFormat:

- (instancetype) initWithPath: (NSString *)  path
inputFormat: (FMLiveSwitchAudioFormat *)  inputFormat 

Initializes a new instance of the FMLiveSwitchOggAudioRecorder class.

Parameters
pathThe path.
inputFormatThe input format.

◆ setArtist:

- (void) setArtist: (NSString *)  value

Sets the file artist.

◆ setTitle:

- (void) setTitle: (NSString *)  value

Sets the file title.

◆ setVendor:

- (void) setVendor: (NSString *)  value

Sets the file vendor.

◆ title

- (NSString*) title

Gets the file title.

◆ vendor

- (NSString*) vendor

Gets the file vendor.