zdk.objc
Instance Methods | Properties | List of all members
<ZDKSound> Protocol Reference

ZDK Sound description. More...

#import <ZDKSound.h>

Inheritance diagram for <ZDKSound>:
<ZDKZHandle>

Instance Methods

(NSString *) - handlesDescription
 
- Instance Methods inherited from <ZDKZHandle>
(long int) - handle
 
(void) - initialize
 
(void) - releaseReference
 
(NSString *) - handlesDescription
 

Properties

long int soundHandle
 Gets the underlying sound handler ID. More...
 
NSString *_Nullable path
 Gets the path to the file this Sound was created from. More...
 
int frequency
 
int lengthSamples
 
int approximateLengthMs
 
int channelCount
 
BOOL repeat
 
int pause
 

Detailed Description

ZDK Sound description.

Method Documentation

◆ handlesDescription

- (NSString *) handlesDescription

Reimplemented from <ZDKZHandle>.

Property Documentation

◆ path

- (NSString* _Nullable) path
readnonatomicassign

Gets the path to the file this Sound was created from.

Returns
The path to the sound file in case the sound is created from such, NULL otherwise.

◆ soundHandle

- (long int) soundHandle
readnonatomicassign

Gets the underlying sound handler ID.

Internally assigned on successful addSound() invocation and invalidated on removeSound().

Returns
The underlying sound handler ZDKD

The documentation for this protocol was generated from the following file: