Agora RTC Objective-C API Reference  Refactor
Properties
AgoraMusic Class Reference

Inherits <NSObject>.

Properties

NSInteger songCode
 
NSInteger type
 
NSInteger pitchType
 
NSString * name
 
NSString * singer
 
NSString * poster
 
NSString * releaseTime
 
NSInteger durationS
 
NSArray< NSNumber * > * lyricList
 
NSArray< AgoraMvProperty * > * mvPropertyList
 
NSArray< AgoraClimaxSegment * > * climaxSegmentList
 

Property Documentation

◆ songCode

- (NSInteger) songCode
readwritenonatomicassign

The ID of the music resource, used to identify a music resource.

◆ type

- (NSInteger) type
readwritenonatomicassign

Music resource types:

  • 1: An individual mode audio track with accompaniment in the left channel and original vocals in the right channel.
  • 2: An individual mode audio track with accompaniment only.
  • 3: An individual mode audio track with original vocals only.
  • 4: A multi-track audio source.

◆ pitchType

- (NSInteger) pitchType
readwritenonatomicassign

Whether the song supports the singing scoring feature:

  • 1: The song supports the singing scoring feature.
  • 2: The song does not support the singing scoring feature.

◆ name

- (NSString*) name
readwritenonatomiccopy

Name of the music resource.

◆ singer

- (NSString*) singer
readwritenonatomiccopy

Singer name.

◆ poster

- (NSString*) poster
readwritenonatomiccopy

The download URL of the music resource poster.

◆ releaseTime

- (NSString*) releaseTime
readwritenonatomiccopy

The release time of the music resource.

◆ durationS

- (NSInteger) durationS
readwritenonatomicassign

Total duration of the music resource (in seconds).

◆ lyricList

- (NSArray<NSNumber *>*) lyricList
readwritenonatomicstrong

Supported lyric types:

  • 0: xml format.
  • 1: lrc format.

◆ mvPropertyList

- (NSArray<AgoraMvProperty *>*) mvPropertyList
readwritenonatomicstrong

The mv property list of music

◆ climaxSegmentList

- (NSArray<AgoraClimaxSegment *>*) climaxSegmentList
readwritenonatomicstrong

List of music climax segments. See AgoraClimaxSegment for details.