com.vk.sdk.api.model

Class VKApiAudio

java.lang.Object

com.vk.sdk.api.model.VKApiModel

com.vk.sdk.api.model.VKAttachments.VKApiAttachment

com.vk.sdk.api.model.VKApiAudio

All Implemented Interfaces:

android.os.Parcelable, Identifiable

public class VKApiAudio
extends VKAttachments.VKApiAttachment
implements Identifiable, android.os.Parcelable

An audio object describes an audio file and contains the following fields.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	VKApiAudio.Genre Audio object genres.

Nested classes/interfaces inherited from interface android.os.Parcelable

android.os.Parcelable.ClassLoaderCreator<T>, android.os.Parcelable.Creator<T>

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	access_key An access key using for get information about hidden objects.
int	album_id ID of the album containing the audio file (if assigned).
java.lang.String	artist Artist name.
static android.os.Parcelable.Creator<VKApiAudio>	CREATOR
int	duration Duration (in seconds).
int	genre Genre ID.
int	id Audio ID.
int	lyrics_id ID of the lyrics (if available) of the audio file.
int	owner_id Audio owner ID.
java.lang.String	title Audio file title.
java.lang.String	url Link to mp3.

Fields inherited from class com.vk.sdk.api.model.VKApiModel

fields

Fields inherited from interface android.os.Parcelable

CONTENTS_FILE_DESCRIPTOR, PARCELABLE_WRITE_RETURN_VALUE

Constructor Summary

Constructors

Constructor and Description
VKApiAudio() Creates empty Audio instance.
VKApiAudio(org.json.JSONObject from)
VKApiAudio(android.os.Parcel in) Creates an Audio instance from Parcel.

Method Summary

Modifier and Type	Method and Description
int	describeContents()
int	getId() Returns unique identifier of this object(usually it's value of JSON field "id").
java.lang.String	getType()
VKApiAudio	parse(org.json.JSONObject from) Fills an Audio instance from JSONObject.
java.lang.CharSequence	toAttachmentString() Convert attachment to special string to attach it to the post, message or comment.
void	writeToParcel(android.os.Parcel dest, int flags)

Methods inherited from class com.vk.sdk.api.model.VKApiModel

getTag, getTag, setTag, setTag

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

id

public int id

Audio ID.

owner_id

public int owner_id

Audio owner ID.

artist

public java.lang.String artist

Artist name.

title

public java.lang.String title

Audio file title.

duration

public int duration

Duration (in seconds).

url

public java.lang.String url

Link to mp3.

lyrics_id

public int lyrics_id

ID of the lyrics (if available) of the audio file.

album_id

public int album_id

ID of the album containing the audio file (if assigned).

genre

public int genre

Genre ID. See the list of audio genres.

access_key

public java.lang.String access_key

An access key using for get information about hidden objects.

CREATOR

public static android.os.Parcelable.Creator<VKApiAudio> CREATOR

Constructor Detail

VKApiAudio

public VKApiAudio(org.json.JSONObject from)

VKApiAudio

public VKApiAudio(android.os.Parcel in)

Creates an Audio instance from Parcel.

VKApiAudio

public VKApiAudio()

Creates empty Audio instance.

Method Detail

parse

public VKApiAudio parse(org.json.JSONObject from)

Fills an Audio instance from JSONObject.

Overrides:

parse in class VKApiModel

Parameters:

from - server API object.

Returns:

this object.

getId

public int getId()

Description copied from interface: Identifiable

Returns unique identifier of this object(usually it's value of JSON field "id").

Specified by:

getId in interface Identifiable

toAttachmentString

public java.lang.CharSequence toAttachmentString()

Description copied from class: VKAttachments.VKApiAttachment

Convert attachment to special string to attach it to the post, message or comment.

Specified by:

toAttachmentString in class VKAttachments.VKApiAttachment

getType

public java.lang.String getType()

Specified by:

getType in class VKAttachments.VKApiAttachment

Returns:

type of this attachment

describeContents

public int describeContents()

Specified by:

describeContents in interface android.os.Parcelable

writeToParcel

public void writeToParcel(android.os.Parcel dest,
                          int flags)

Specified by:

writeToParcel in interface android.os.Parcelable