Ballerina library

soundcloud

Module soundcloud

Overview

API

Client

Definitions

Activities
ActivitiesCollection
ApiKeysConfig
ClientHttp1Settings
Comment
Comments
CommentUser
CompleteUser
CompleteuserQuota
Connection
ConnectionConfig
CreateUpdatePlaylistRequest
CreateupdateplaylistrequestPlaylist
CreateupdateplaylistrequestPlaylistTracks
Error
Found
InlineResponse201
InlineResponse201Tracks
MetaUser
MetaUsers
Playlist
Playlists
ProxyConfig
Streams
TooManyRequests
Track
TrackDataRequest
TrackIdCommentsBody
TrackMetadataRequest
TrackmetadatarequestTrack
Tracks
TrackstrackIdcommentsComment
User
Users
UserslistInner
WebprofilesInner

InlineResponse200
InlineResponse2001
InlineResponse2002
InlineResponse2003

ballerinax/soundcloud Ballerina library

1.5.1

Overview

This is a generated connector for SoundCloud API v1.0.0 OpenAPI Specification.

SoundCloud API provides capability to access the online audio distribution platform and music sharing website that enables you to upload,promote, and share audio, as well as a digital signal processor enabling listeners to stream audio.

Clients

soundcloud: Client

Isolated

This is a generated connector for SoundCloud API v1.0.0 OpenAPI Specification. SoundCloud API provides capability to access the online audio distribution platform and music sharing website that enables you to upload,promote, and share audio, as well as a digital signal processor enabling listeners to stream audio.

Constructor

Gets invoked to initialize the connector. The connector initialization requires setting the API credentials. Create an SoundCloud account and obtain tokens following this guide.

init (ApiKeysConfig apiKeyConfig, ConnectionConfig config, string serviceUrl)
  • config ConnectionConfig {} - The configurations to be used when initializing the connector
  • serviceUrl string "https://api.soundcloud.com" - URL of the target service

likePlaylist

Isolated FunctionRemote Function
function likePlaylist(int playlistId) returns json|error

Likes a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

unlikePlaylist

Isolated FunctionRemote Function
function unlikePlaylist(int playlistId) returns json|error

Unlikes a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

likeTrack

Isolated FunctionRemote Function
function likeTrack(int trackId) returns json|error

Likes a track.

Parameters
  • trackId int - SoundCloud Track id
Return Type

unlikeTrack

Isolated FunctionRemote Function
function unlikeTrack(int trackId) returns json|error

Unlikes a track.

Parameters
  • trackId int - SoundCloud Track id
Return Type

getUserDetail

Isolated FunctionRemote Function
function getUserDetail() returns CompleteUser|error

Returns the authenticated user’s information.

Return Type

getActivities

Isolated FunctionRemote Function
function getActivities(string[]? access, int 'limit) returns Activities|error

Returns the authenticated user's activities.

Parameters
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

getOwnActivities

Isolated FunctionRemote Function
function getOwnActivities(string[]? access, int 'limit) returns Activities|error

Recent the authenticated user's activities.

Parameters
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

getRecentTrackRelatedActivities

Isolated FunctionRemote Function
function getRecentTrackRelatedActivities(string[]? access, int 'limit) returns Activities|error

Returns the authenticated user's recent track related activities.

Parameters
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

listConnectedSocialAccounts

Isolated FunctionRemote Function
function listConnectedSocialAccounts(int 'limit, int offset) returns Connections|error

Returns a list of the authenticated user's connected social accounts.

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type
  • Connections|error - Success

getConnectionByID

Isolated FunctionRemote Function
function getConnectionByID(int connectionId) returns Connection|error

Returns the authenticated user's connected social account.

Parameters
  • connectionId int - SoundCloud connection id
Return Type

getFollowers

Isolated FunctionRemote Function
function getFollowers(int 'limit) returns InlineResponse200|error

Returns a list of users who are following the authenticated user.

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

listFollowings

Isolated FunctionRemote Function
function listFollowings(int 'limit, int offset) returns InlineResponse200|error

Returns a list of users who are followed by the authenticated user.

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

listRecentTracks

Isolated FunctionRemote Function
function listRecentTracks(string[]? access, int 'limit, int offset) returns TracksList|error

Returns a list of recent tracks from users followed by the authenticated user.

Parameters
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type
  • TracksList|error - Success

followUser

Isolated FunctionRemote Function
function followUser(int userId) returns User|json|error

Follows a user.

Parameters
  • userId int - SoundCloud User id
Return Type

deleteFollowing

Isolated FunctionRemote Function
function deleteFollowing(int userId) returns json|error

Deletes a user who is followed by the authenticated user.

Parameters
  • userId int - SoundCloud User id
Return Type

listLikedTracks

Isolated FunctionRemote Function
function listLikedTracks(int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|error

Returns a list of favorites or liked tracks of the authenticated user.

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type

listPlaylist

Isolated FunctionRemote Function
function listPlaylist(int 'limit) returns PlaylistsArray|error

Returns user’s playlists (sets).

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type
  • PlaylistsArray|error - Success

listTracks

Isolated FunctionRemote Function
function listTracks(int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|error

Returns a list of user's tracks.

Parameters
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type

searchPlaylist

Isolated FunctionRemote Function
function searchPlaylist(string q, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2002|error

Performs a playlist search based on a query

Parameters
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

createPlaylist

Isolated FunctionRemote Function
function createPlaylist(CreateUpdatePlaylistRequest payload) returns InlineResponse201|error

Creates a playlist.

Parameters
Return Type

getPlaylist

Isolated FunctionRemote Function
function getPlaylist(int playlistId, string? secretToken, string[]? access) returns Playlist|error

Returns a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
  • secretToken string? (default ()) - A secret token to fetch private playlists/tracks
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
Return Type

updatePlaylist

Isolated FunctionRemote Function
function updatePlaylist(int playlistId, CreateUpdatePlaylistRequest payload) returns InlineResponse201|error

Updates a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

deletePlaylist

Isolated FunctionRemote Function
function deletePlaylist(int playlistId) returns Response|error

Deletes a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

listReposts

Isolated FunctionRemote Function
function listReposts(int playlistId, int 'limit) returns MetaUsers|error

Returns a collection of playlist's reposters.

Parameters
  • playlistId int - SoundCloud playlist id
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

getTracksUnderPlaylist

Isolated FunctionRemote Function
function getTracksUnderPlaylist(int playlistId, string? secretToken, string[]? access, boolean? linkedPartitioning) returns InlineResponse2001|error

Returns tracks under a playlist.

Parameters
  • playlistId int - SoundCloud playlist id
  • secretToken string? (default ()) - A secret token to fetch private playlists/tracks
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type

repostPlaylist

Isolated FunctionRemote Function
function repostPlaylist(int playlistId) returns Response|error

Reposts a playlist as the authenticated user

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

deleteRepost

Isolated FunctionRemote Function
function deleteRepost(int playlistId) returns Response|error

Removes a repost on a playlist as the authenticated user

Parameters
  • playlistId int - SoundCloud playlist id
Return Type

repostTrackByTrackID

Isolated FunctionRemote Function
function repostTrackByTrackID(int trackId) returns Response|error

Reposts a track as the authenticated user

Parameters
  • trackId int - SoundCloud Track id
Return Type

deleteRepostOnTrack

Isolated FunctionRemote Function
function deleteRepostOnTrack(int trackId) returns Response|error

Removes a repost on a track as the authenticated user

Parameters
  • trackId int - SoundCloud Track id
Return Type

resolveSoundCloudURLToResourceURL

Isolated FunctionRemote Function
function resolveSoundCloudURLToResourceURL(string url) returns Response|error

Resolves soundcloud.com URLs to Resource URLs to use with the API.

Parameters
Return Type

searchTracks

Isolated FunctionRemote Function
function searchTracks(string q, string? ids, string? genres, string? tags, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2001|error

Performs a track search based on a query

Parameters
  • ids string? (default ()) - A comma separated list of track ids to filter on
  • genres string? (default ()) - A comma separated list of genres
  • tags string? (default ()) - A comma separated list of tags
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

getTrackByID

Isolated FunctionRemote Function
function getTrackByID(int trackId, string? secretToken) returns Track|error

Returns a track.

Parameters
  • trackId int - SoundCloud Track id
  • secretToken string? (default ()) - A secret token to fetch private playlists/tracks
Return Type

deleteTrack

Isolated FunctionRemote Function
function deleteTrack(int trackId) returns Response|error

Deletes a track.

Parameters
  • trackId int - SoundCloud Track id
Return Type

getCommentsOnTrack

Isolated FunctionRemote Function
function getCommentsOnTrack(int trackId, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2003|error

Returns the comments posted on the track(track_id).

Parameters
  • trackId int - SoundCloud Track id
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

addComment

Isolated FunctionRemote Function
function addComment(int trackId, TrackIdCommentsBody payload) returns Comment|error

Returns the newly created comment on success

Parameters
  • trackId int - SoundCloud Track id
Return Type

getLikedUsersOfTrack

Isolated FunctionRemote Function
function getLikedUsersOfTrack(int trackId, int 'limit, int offset) returns UsersList|error

Returns a list of users who have favorited or liked the track.

Parameters
  • trackId int - SoundCloud Track id
  • 'limit int (default 50) - Number of results to return in the collection.
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type
  • UsersList|error - Success

listRelatedTracksOfTrack

Isolated FunctionRemote Function
function listRelatedTracksOfTrack(int trackId, string[]? access, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse2001|error

Returns all related tracks of track on SoundCloud.

Parameters
  • trackId int - SoundCloud Track id
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

getRepostCollection

Isolated FunctionRemote Function
function getRepostCollection(int trackId, int 'limit) returns MetaUsers|error

Returns a collection of track's reposters.

Parameters
  • trackId int - SoundCloud Track id
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

getStreambleURL

Isolated FunctionRemote Function
function getStreambleURL(int trackId, string? secretToken) returns Streams|error

Returns a track's streamable URLs

Parameters
  • trackId int - SoundCloud Track id
  • secretToken string? (default ()) - A secret token to fetch private playlists/tracks
Return Type

searchUser

Isolated FunctionRemote Function
function searchUser(string q, string? ids, int 'limit, boolean? linkedPartitioning, int offset) returns InlineResponse200|error

Performs a user search based on a query

Parameters
  • ids string? (default ()) - A comma separated list of track ids to filter on
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type

getUserByID

Isolated FunctionRemote Function
function getUserByID(int userId) returns CompleteUser|error

Returns a user.

Parameters
  • userId int - SoundCloud User id
Return Type

listUserComments

Isolated FunctionRemote Function
function listUserComments(int userId, int 'limit, int offset) returns CommentsList|error

Returns a list of user's comments.

Parameters
  • userId int - SoundCloud User id
  • 'limit int (default 50) - Number of results to return in the collection.
  • offset int (default 0) - Offset of first result. Deprecated, use linked_partitioning instead.

    Deprecated parameters

    • Deprecated
Return Type
  • CommentsList|error - Success

listFollowers

Isolated FunctionRemote Function
function listFollowers(int userId, int 'limit) returns InlineResponse200|error

Returns a list of user’s followers.

Parameters
  • userId int - SoundCloud User id
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

listUserFollowings

Isolated FunctionRemote Function
function listUserFollowings(int userId, int 'limit) returns InlineResponse200|error

Returns a list of user’s followings.

Parameters
  • userId int - SoundCloud User id
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type

listUserLikedTracks

Isolated FunctionRemote Function
function listUserLikedTracks(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|error

Returns a list of user's liked tracks.

Parameters
  • userId int - SoundCloud User id
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type

listUserPlaylist

Isolated FunctionRemote Function
function listUserPlaylist(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2002|error

Returns a list of user's playlists.

Parameters
  • userId int - SoundCloud User id
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type

listUserTracks

Isolated FunctionRemote Function
function listUserTracks(int userId, string[]? access, int 'limit, boolean? linkedPartitioning) returns InlineResponse2001|error

Returns a list of user's tracks.

Parameters
  • userId int - SoundCloud User id
  • access string[]? (default ()) - Filters content by level of access the user (logged in or anonymous) has to the track. The result list will include only tracks with the specified access. Include all options if you'd like to see all possible tracks. See Track#access schema for more details.
  • 'limit int (default 50) - Number of results to return in the collection.
  • linkedPartitioning boolean? (default ()) - Returns paginated collection of items (recommended, returning a list without pagination is deprecated and should not be used)
Return Type
Isolated FunctionRemote Function
function listUserLinks(int userId, int 'limit) returns WebProfiles|error

Returns list of user's links added to their profile (website, facebook, instagram).

Parameters
  • userId int - SoundCloud User id
  • 'limit int (default 50) - Number of results to return in the collection.
Return Type
  • WebProfiles|error - Success

Records

soundcloud: Activities

User's activities.

Fields

soundcloud: ActivitiesCollection

Fields
  • created_at string? - Created timestamp.
  • 'type string? - Type of activity (track).

soundcloud: ApiKeysConfig

Closed record

Provides API key configurations needed when communicating with a remote HTTP endpoint.

Fields
  • authorization string - Represents API Key Authorization

soundcloud: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request

soundcloud: Comment

User's Comment

Fields
  • created_at string? - Created timestamp.
  • id int? - Identifier.
  • kind string? - Kind (comment).
  • timestamp string? - Timestamp.
  • track_id int? - Track's identifier.
  • user_id int? - User's identifier.

soundcloud: Comments

Fields

soundcloud: CommentUser

SoundCloud User object

Fields
  • avatar_url string? - URL to a JPEG image.
  • followers_count int? - number of followers.
  • followings_count int? - number of followed users.
  • id int? - unique identifier
  • kind string? - kind of resource.
  • last_modified string? - last modified timestamp.
  • reposts_count int? - number of reposts from user
  • uri string? - API resource URL.

soundcloud: CompleteUser

SoundCloud Complete User object

Fields
  • avatar_url string? - URL to a JPEG image.
  • description string? - description.
  • discogs_name string? - discogs name.
  • first_name string? - first name.
  • followers_count int? - number of followers.
  • followings_count int? - number of followed users.
  • full_name string? - first and last name.
  • id int? - unique identifier
  • kind string? - kind of resource.
  • last_modified string? - last modified timestamp.
  • last_name string? - last name.
  • myspace_name string? - myspace name
  • plan string? - subscription plan of the user.
  • playlist_count int? - number of public playlists.
  • primary_email_confirmed boolean? - boolean if email is confirmed.
  • private_playlists_count int? - number of private playlists.
  • private_tracks_count int? - number of private tracks.
  • public_favorites_count int? - number of favorited public tracks
  • reposts_count int? - number of reposts from user
  • subscriptions anydata[]? - a list subscriptions associated with the user
  • track_count int? - number of public tracks.
  • uri string? - API resource URL.
  • website string? - a URL to the website.
  • website_title string? - a custom title for the website.

soundcloud: CompleteuserQuota

user's upload quota

Fields
  • unlimited_upload_quota boolean? - unlimited upload quota.
  • upload_seconds_used int? - upload seconds used.

soundcloud: Connection

Fields
  • created_at string? - Created timestamp.
  • display_name string? - Full Name.
  • id int? - Unique identifier
  • kind string? - Kind of resource.
  • uri string? - The external link URI.

soundcloud: ConnectionConfig

Closed record

Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.

Fields
  • httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
  • timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
  • forwarded string(default "disable") - The choice of setting forwarded/x-forwarded header
  • cache CacheConfig? - HTTP caching related configurations
  • compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (accept-encoding) header
  • circuitBreaker CircuitBreakerConfig? - Configurations associated with the behaviour of the Circuit Breaker
  • retryConfig RetryConfig? - Configurations associated with retrying
  • validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default

soundcloud: CreateUpdatePlaylistRequest

Fields

soundcloud: CreateupdateplaylistrequestPlaylist

Fields
  • description string? - Description of the playlist
  • sharing string? - public or private
  • title string? - Title of the playlist

soundcloud: CreateupdateplaylistrequestPlaylistTracks

Fields
  • id string - SoundCloud track id

soundcloud: Error

Fields
  • errors anydata[]? -

soundcloud: Found

Fields
  • location string? - Location URL of the resource.

soundcloud: InlineResponse201

Soundcloud Playlist Object

Fields
  • artwork_url string? - URL to a JPEG image.
  • created_at string? - Created timestamp.
  • description string? - Playlist description.
  • downloadable boolean? - is downloadable.
  • duration int? - Playlist duration.
  • ean string? - European Article Number.
  • embeddable_by string? - Embeddable by.
  • genre string? - Playlist genre.
  • id int? - Playlist identifier.
  • kind string? - Type of Soundcloud object (playlist).
  • label_id int? - Label user identifier.
  • label_name string? - Label name.
  • last_modified string? - Last modified timestamp.
  • playlist_type string? - Type of playlist.
  • purchase_title string? - Purchase title.
  • purchase_url string? - Purchase URL.
  • release_day int? - Day of release.
  • release_month int? - Month of release.
  • release_year int? - Year of release.
  • sharing string? - Type of sharing (private/public).
  • streamable boolean? - Is streamable.
  • title string? - Playlist title.
  • track_count int? - Count of tracks.
  • 'type string? - Playlist type.
  • user MetaUser? - SoundCloud User object.
  • user_id int? - User identifier.

soundcloud: InlineResponse201Tracks

Soundcloud Track object.

Fields
  • artwork_url string? - URL to a JPEG image.
  • bpm int? - Tempo.
  • comment_count int? - Number of comments.
  • commentable boolean? - Is commentable.
  • created_at string? - Created timestamp.
  • description string? - Track description.
  • download_count int? - NUmber of downloads.
  • downloadable string? - Is downloadable.
  • duration int? - Track duration.
  • embeddable_by string? - Embeddable by.
  • favoritings_count int? - Number of favoritings.
  • id int? - Track identifier.
  • key_signature string? - Key signature.
  • kind string? - Type of object (track).
  • label_name string? - Label user name.
  • playback_count int? - Number of plays.
  • purchase_title string? - Purchase title.
  • purchase_url string? - Purchase URL.
  • release_day int? - Day of release.
  • release_month int? - Month of release.
  • release_year int? - Year of release.
  • sharing string? - Type of sharing (public/private).
  • stream_url string? - URL to stream.
  • streamable boolean? - Is streamable.
  • user MetaUser? - SoundCloud User object.
  • user_favorite boolean? - Is user's favourite.
  • user_playback_count int? - Number of plays by a user.
  • waveform_url string? - Waveform URL.

soundcloud: MetaUser

SoundCloud User object.

Fields
  • avatar_url string? - URL to a JPEG image
  • created_at string? - profile creation datetime
  • id int? - unique identifier
  • kind string? - kind of resource
  • last_modified string? - last modified datetime
  • uri string? - API resource URL

soundcloud: MetaUsers

Fields

soundcloud: Playlist

Soundcloud Playlist Object

Fields
  • artwork_url string? - URL to a JPEG image.
  • created_at string? - Created timestamp.
  • description string? - Playlist description.
  • downloadable boolean? - is downloadable.
  • duration int? - Playlist duration.
  • ean string? - European Article Number.
  • embeddable_by string? - Embeddable by.
  • genre string? - Playlist genre.
  • id int? - Playlist identifier.
  • kind string? - Type of Soundcloud object (playlist).
  • label MetaUser? - SoundCloud User object.
  • label_id int? - Label user identifier.
  • label_name string? - Label name.
  • last_modified string? - Last modified timestamp.
  • likes_count int? - Count of playlist likes.
  • playlist_type string? - Type of playlist.
  • purchase_title string? - Purchase title.
  • purchase_url string? - Purchase URL.
  • release_day int? - Day of release.
  • release_month int? - Month of release.
  • release_year int? - Year of release.
  • sharing string? - Type of sharing (private/public).
  • streamable boolean? - Is streamable.
  • title string? - Playlist title.
  • track_count int? - Count of tracks.
  • tracks Track[]? - List of tracks.
  • tracks_uri string? - tracks URI.
  • 'type string? - Playlist type.
  • user MetaUser? - SoundCloud User object.
  • user_id int? - User identifier.

soundcloud: Playlists

Fields

soundcloud: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - Proxy server password

soundcloud: Streams

Fields
  • preview_mp3_128_url string? -

soundcloud: TooManyRequests

Fields
  • Fields Included from * Error

soundcloud: Track

Soundcloud Track object.

Fields
  • access string? - Level of access the user (logged in or anonymous) has to the track.
    • playable - user is allowed to listen to a full track.
    • preview - user is allowed to preview a track, meaning a snippet is available
    • blocked - user can only see the metadata of a track, no streaming is possible
  • artwork_url string? - URL to a JPEG image.
  • available_country_codes string? - List of countries where track is available.
  • bpm int? - Tempo.
  • comment_count int? - Number of comments.
  • commentable boolean? - Is commentable.
  • created_at string? - Created timestamp.
  • description string? - Track description.
  • download_count int? - NUmber of downloads.
  • download_url string? - URL to download a track.
  • downloadable string? - Is downloadable.
  • duration int? - Track duration.
  • embeddable_by string? - Embeddable by.
  • favoritings_count int? - Number of favoritings.
  • id int? - Track identifier.
  • key_signature string? - Key signature.
  • kind string? - Type of object (track).
  • label_name string? - Label user name.
  • playback_count int? - Number of plays.
  • purchase_title string? - Purchase title.
  • purchase_url string? - Purchase URL.
  • release_day int? - Day of release.
  • release_month int? - Month of release.
  • release_year int? - Year of release.
  • reposts_count int? - Number of reposts.
  • secret_uri string? - Secret URL.
  • sharing string? - Type of sharing (public/private).
  • stream_url string? - URL to stream.
  • streamable boolean? - Is streamable.
  • user MetaUser? - SoundCloud User object.
  • user_favorite boolean? - Is user's favourite.
  • user_playback_count int? - Number of plays by a user.
  • waveform_url string? - Waveform URL.

soundcloud: TrackDataRequest

Fields
  • 'track\[artwork\_data\] string? -
  • 'track\[asset\_data\] string? -
  • 'track\[description\] string? -
  • 'track\[embeddable\_by\] string? - who can embed this track "all", "me", or "none"
  • 'track\[label\_name\] string? -
  • 'track\[license\] string? - Possible values: no-rights-reserved, all-rights-reserved, cc-by, cc-by-nc, cc-by-nd, cc-by-sa, cc-by-nc-nd, cc-by-nc-sa
  • 'track\[permalink\] string? -
  • 'track\[purchase\_url\] string? -
  • 'track\[release\_date\] string? - string, formatted as yyyy-mm-dd, representing release date
  • 'track\[tag\_list\] string? - The tag_list property contains a list of tags separated by spaces. Multiword tags are quoted in double quotes. We also support machine tags that follow the pattern NAMESPACE:KEY=VALUE. For example: geo:lat=43.555 camel:size=medium “machine:tag=with space” Machine tags are not revealed to the user on the track pages.

soundcloud: TrackIdCommentsBody

Fields

soundcloud: TrackMetadataRequest

Fields

soundcloud: TrackmetadatarequestTrack

Fields
  • embeddable_by string? - who can embed this track "all", "me", or "none"
  • license string? - Possible values: no-rights-reserved, all-rights-reserved, cc-by, cc-by-nc, cc-by-nd, cc-by-sa, cc-by-nc-nd, cc-by-nc-sa
  • release_date string? - string, formatted as yyyy-mm-dd, representing release date
  • tag_list string? - The tag_list property contains a list of tags separated by spaces. Multiword tags are quoted in double quotes. We also support machine tags that follow the pattern NAMESPACE:KEY=VALUE. For example: geo:lat=43.555 camel:size=medium “machine:tag=with space” Machine tags are not revealed to the user on the track pages.

soundcloud: Tracks

Fields

soundcloud: TrackstrackIdcommentsComment

Fields
  • body string - Comment's content
  • timestamp string|decimal? - Timestamp of a comment. String or float representation is supported

soundcloud: User

SoundCloud User object

Fields
  • avatar_url string? - URL to a JPEG image
  • created_at string? - profile creation datetime
  • description string? - description
  • discogs_name string? - discogs name
  • first_name string? - first name
  • followers_count int? - number of followers
  • followings_count int? - number of followed users
  • full_name string? - first and last name
  • id int? - unique identifier
  • kind string? - kind of resource
  • last_modified string? - last modified datetime
  • myspace_name string? - myspace name
  • plan string? - subscription plan of the user
  • playlist_count int? - number of public playlists
  • public_favorites_count int? - number of favorited public tracks
  • reposts_count int? - number of reposts from user
  • subscriptions anydata[]? - a list subscriptions associated with the user
  • track_count int? - number of public tracks
  • uri string? - API resource URL
  • website string? - a URL to the website
  • website_title string? - a custom title for the website

soundcloud: Users

Fields
  • collection User[]? -

soundcloud: UserslistInner

SoundCloud User object

Fields
  • avatar_url string? - URL to a JPEG image
  • description string? - description
  • discogs_name string? - discogs name
  • first_name string? - first name
  • followers_count int? - number of followers
  • followings_count int? - number of followed users
  • full_name string? - first and last name
  • id int? - unique identifier
  • kind string? - kind of resource
  • last_modified string? - last modified datetime
  • myspace_name string? - myspace name
  • plan string? - subscription plan of the user
  • playlist_count int? - number of public playlists
  • public_favorites_count int? - number of favorited public tracks
  • reposts_count int? - number of reposts from user
  • subscriptions anydata[]? - a list subscriptions associated with the user
  • track_count int? - number of public tracks
  • uri string? - API resource URL
  • website string? - a URL to the website
  • website_title string? - a custom title for the website

soundcloud: WebprofilesInner

Fields
  • created_at string? - Timestamp of when the link was added to the profile.
  • 'service string? - Service or platform
  • url string? - URL of the external link
  • username string? - Username extracted from the external link

Union types

soundcloud: InlineResponse200

Users|UsersList

InlineResponse200

soundcloud: InlineResponse2001

Tracks|TracksList

InlineResponse2001

soundcloud: InlineResponse2002

Playlists|PlaylistsArray

InlineResponse2002

soundcloud: InlineResponse2003

Comments|CommentsList

InlineResponse2003

Import

import ballerinax/soundcloud;Copy

Metadata

Released date: 12 months ago

Version: 1.5.1

License: Apache-2.0

Compatibility

Platform: any

Ballerina version: 2201.4.1

GraalVM compatible: Yes

Pull count

Total: 0

Current verison: 0

Weekly downloads

Source repository

Keywords

Content & Files/Video & Audio

Cost/Freemium

Contributors

Other versions

1.5.1

1.5.01.4.01.2.01.1.0
See more...

Dependencies

ballerina/url/2.2.3ballerina/http/2.6.1

Terms of service

Privacy policy

Cookie policy

Delete policy

© 2024 WSO2 LLC