cloud::audiocom::ServiceConfig Class Reference

Configuration for the audio.com. More...

#include <ServiceConfig.h>

Public Member Functions
std::string_view	GetAPIEndpoint () const
	API endpoint. More...
std::string_view	GetOAuthLoginPage () const
	Page to open in browser to initiate OAuth. More...
std::string_view	GetOAuthClientID () const
	OAuth2 client ID. More...
std::string_view	GetOAuthRedirectURL () const
	OAuth2 redirect URL. Only used to satisfy the protocol. More...
std::string	GetAPIUrl (std::string_view apiURI) const
	Helper to construct the full URLs for the API. More...
std::string	GetFinishUploadPage (std::string_view audioID, std::string_view token) const
	Helper to construct the page URL for the anonymous upload last stage. More...
std::chrono::milliseconds	GetProgressCallbackTimeout () const
	Timeout between progress callbacks. More...
MimeTypesList	GetPreferredAudioFormats () const
	Preferred audio format. More...
MimeType	GetDownloadMime () const
	Return the mime type server should store the file. This is a requirement from audiocom. More...

Detailed Description

Configuration for the audio.com.

Definition at line 23 of file ServiceConfig.h.

Member Function Documentation

GetAPIEndpoint()

std::string_view cloud::audiocom::ServiceConfig::GetAPIEndpoint

(

)

const

API endpoint.

Definition at line 15 of file ServiceConfig.cpp.

{
   return "https://api.audio.com";
}

Referenced by GetAPIUrl().

Here is the caller graph for this function:

GetAPIUrl()

std::string cloud::audiocom::ServiceConfig::GetAPIUrl

(

std::string_view

apiURI

)

const

Helper to construct the full URLs for the API.

Definition at line 40 of file ServiceConfig.cpp.

{
   return std::string(GetAPIEndpoint()) + std::string(apiURI);
}

References GetAPIEndpoint().

Referenced by cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::DiscardResult(), cloud::audiocom::OAuthService::DoAuthorise(), and cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::InitiateUpload().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDownloadMime()

MimeType cloud::audiocom::ServiceConfig::GetDownloadMime

(

)

const

Return the mime type server should store the file. This is a requirement from audiocom.

Definition at line 63 of file ServiceConfig.cpp.

{
   return "audio/x-wav";
}

Referenced by cloud::audiocom::anonymous_namespace{UploadService.cpp}::GetUploadRequestPayload().

Here is the caller graph for this function:

GetFinishUploadPage()

std::string cloud::audiocom::ServiceConfig::GetFinishUploadPage	(	std::string_view	audioID,
		std::string_view	token
	)		const

Helper to construct the page URL for the anonymous upload last stage.

Definition at line 45 of file ServiceConfig.cpp.

{
   return "http://audio.com/audacity/upload?audioId=" + std::string(audioID) +
          "&token=" + std::string(token) +
          "&clientId=" + std::string(GetOAuthClientID());
}

References GetOAuthClientID().

Referenced by cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::CompletePromise().

Here is the call graph for this function:

Here is the caller graph for this function:

GetOAuthClientID()

std::string_view cloud::audiocom::ServiceConfig::GetOAuthClientID

(

)

const

OAuth2 client ID.

Definition at line 29 of file ServiceConfig.cpp.

{
   return "1741964426607541";
}

Referenced by GetFinishUploadPage(), GetOAuthLoginPage(), and cloud::audiocom::anonymous_namespace{OAuthService.cpp}::WriteCommonFields().

Here is the caller graph for this function:

GetOAuthLoginPage()

std::string_view cloud::audiocom::ServiceConfig::GetOAuthLoginPage

(

)

const

Page to open in browser to initiate OAuth.

Definition at line 20 of file ServiceConfig.cpp.

{
   static const std::string loginPage =
      std::string("https://audio.com/audacity/link?clientId=") +
      std::string(GetOAuthClientID());
 
   return loginPage;
}

References GetOAuthClientID().

Here is the call graph for this function:

GetOAuthRedirectURL()

std::string_view cloud::audiocom::ServiceConfig::GetOAuthRedirectURL

(

)

const

OAuth2 redirect URL. Only used to satisfy the protocol.

Definition at line 34 of file ServiceConfig.cpp.

{
   //return "audacity://link";
   return "https://audio.com/auth/sign-in/success";
}

Referenced by cloud::audiocom::OAuthService::AuthoriseCode().

Here is the caller graph for this function:

GetPreferredAudioFormats()

MimeTypesList cloud::audiocom::ServiceConfig::GetPreferredAudioFormats

(

)

const

Preferred audio format.

Definition at line 58 of file ServiceConfig.cpp.

{
   return { "audio/x-wavpack", "audio/x-flac", "audio/x-wav" };
}

GetProgressCallbackTimeout()

std::chrono::milliseconds cloud::audiocom::ServiceConfig::GetProgressCallbackTimeout

(

)

const

Timeout between progress callbacks.

Definition at line 53 of file ServiceConfig.cpp.

{
   return std::chrono::seconds(3);
}

Referenced by cloud::audiocom::anonymous_namespace{UploadService.cpp}::AudiocomUploadOperation::HandleUploadProgress().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following files:

• ServiceConfig.h
• ServiceConfig.cpp