Package org.opencastproject.transcription.googlespeech

Class GoogleSpeechTranscriptionService

java.lang.Object

org.opencastproject.job.api.AbstractJobProducer

org.opencastproject.transcription.googlespeech.GoogleSpeechTranscriptionService

All Implemented Interfaces:

JobProducer, TranscriptionService

public class GoogleSpeechTranscriptionService
extends AbstractJobProducer
implements TranscriptionService

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CLEANUP_RESULTS_DAYS_CONFIG
static final String	COMPLETION_CHECK_BUFFER_CONFIG
static final String	DEFAULT_WF_DEF
static final String	DISPATCH_WORKFLOW_INTERVAL_CONFIG
static final String	ENABLE_PUNCTUATION
static final String	ENABLED_CONFIG	Service configuration options
static final String	ENCODING_EXTENSION
static final String	GOOGLE_CLOUD_BUCKET
static final String	GOOGLE_CLOUD_CLIENT_ID
static final String	GOOGLE_CLOUD_CLIENT_SECRET
static final String	GOOGLE_CLOUD_REFRESH_TOKEN
static final String	GOOGLE_CLOUD_TOKEN_ENDPOINT_URL
static final String	GOOGLE_SPEECH_LANGUAGE
static final String	MAX_PROCESSING_TIME_CONFIG
static final String	NOTIFICATION_EMAIL_CONFIG
static final String	PROFANITY_FILTER
static final String	TRANSCRIPTION_MODEL
static final String	WORKFLOW_CONFIG

Fields inherited from class org.opencastproject.job.api.AbstractJobProducer

ACCEPT_JOB_LOADS_EXCEEDING_PROPERTY, acceptJobLoadsExeedingMaxLoad, DEFAULT_ACCEPT_JOB_LOADS_EXCEEDING, executor, jobType

Constructor Summary

Constructors

Constructor	Description
GoogleSpeechTranscriptionService()

Method Summary

Modifier and Type	Method	Description
void	activate(org.osgi.service.component.ComponentContext cc)	OSGI activate method.
protected void	deleteStorageFile(String mpId, String token)
MediaPackageElement	getGeneratedTranscription(String mpId, String jobId, MediaPackageElement.Type type)
String	getLanguage()
protected OrganizationDirectoryService	getOrganizationDirectoryService()	Returns a reference to the organization directory service.
protected String	getRefreshAccessToken()
Map<String,Object>	getReturnValues(String mpId, String jobId)
protected SecurityService	getSecurityService()	Returns a reference to the security service
protected ServiceRegistry	getServiceRegistry()	Returns a reference to the service registry.
String	getTranscriptionResults(String jobId)	Get transcription result: GET /v1/operations/{name} Method mainly used by the REST endpoint
String	getTranscriptionStatus(String mpId)	Get mediapackage transcription status
protected UserDirectoryService	getUserDirectoryService()	Returns a reference to the user directory service
protected org.apache.http.impl.client.CloseableHttpClient	makeHttpClient()
protected String	process(Job job)	Asks the overriding class to process the arguments using the given operation.
protected String	refreshAccessToken(String clientId, String clientSecret, String refreshToken)
void	setAssetManager(AssetManager service)
void	setDatabase(TranscriptionDatabase service)
void	setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)
void	setSecurityService(SecurityService securityService)
void	setServiceRegistry(ServiceRegistry serviceRegistry)
void	setSmtpService(SmtpService service)
void	setUserDirectoryService(UserDirectoryService userDirectoryService)
void	setWorkflowService(WorkflowService service)
void	setWorkingFileRepository(WorkingFileRepository wfr)
void	setWorkspace(Workspace ws)
Job	startTranscription(String mpId, Track track)
Job	startTranscription(String mpId, Track track, String... args)
void	transcriptionDone(String mpId, Object obj)
void	transcriptionError(String mpId, Object obj)
protected String	uploadAudioFileToGoogleStorage(String mpId, Track track)

Methods inherited from class org.opencastproject.job.api.AbstractJobProducer

acceptJob, countJobs, finallyUpdateJob, getJobType, incident, isReadyToAccept, isReadyToAcceptJobs

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_WF_DEF

public static final String DEFAULT_WF_DEF

See Also:

• Constant Field Values

ENABLED_CONFIG

public static final String ENABLED_CONFIG

Service configuration options

See Also:

• Constant Field Values

GOOGLE_SPEECH_LANGUAGE

public static final String GOOGLE_SPEECH_LANGUAGE

See Also:

• Constant Field Values

PROFANITY_FILTER

public static final String PROFANITY_FILTER

See Also:

• Constant Field Values

ENABLE_PUNCTUATION

public static final String ENABLE_PUNCTUATION

See Also:

• Constant Field Values

TRANSCRIPTION_MODEL

public static final String TRANSCRIPTION_MODEL

See Also:

• Constant Field Values

WORKFLOW_CONFIG

public static final String WORKFLOW_CONFIG

See Also:

• Constant Field Values

DISPATCH_WORKFLOW_INTERVAL_CONFIG

public static final String DISPATCH_WORKFLOW_INTERVAL_CONFIG

See Also:

• Constant Field Values

COMPLETION_CHECK_BUFFER_CONFIG

public static final String COMPLETION_CHECK_BUFFER_CONFIG

See Also:

• Constant Field Values

MAX_PROCESSING_TIME_CONFIG

public static final String MAX_PROCESSING_TIME_CONFIG

See Also:

• Constant Field Values

NOTIFICATION_EMAIL_CONFIG

public static final String NOTIFICATION_EMAIL_CONFIG

See Also:

• Constant Field Values

CLEANUP_RESULTS_DAYS_CONFIG

public static final String CLEANUP_RESULTS_DAYS_CONFIG

See Also:

• Constant Field Values

GOOGLE_CLOUD_CLIENT_ID

public static final String GOOGLE_CLOUD_CLIENT_ID

See Also:

• Constant Field Values

GOOGLE_CLOUD_CLIENT_SECRET

public static final String GOOGLE_CLOUD_CLIENT_SECRET

See Also:

• Constant Field Values

GOOGLE_CLOUD_REFRESH_TOKEN

public static final String GOOGLE_CLOUD_REFRESH_TOKEN

See Also:

• Constant Field Values

GOOGLE_CLOUD_BUCKET

public static final String GOOGLE_CLOUD_BUCKET

See Also:

• Constant Field Values

GOOGLE_CLOUD_TOKEN_ENDPOINT_URL

public static final String GOOGLE_CLOUD_TOKEN_ENDPOINT_URL

See Also:

• Constant Field Values

ENCODING_EXTENSION

public static final String ENCODING_EXTENSION

See Also:

• Constant Field Values

Constructor Details

GoogleSpeechTranscriptionService

public GoogleSpeechTranscriptionService()

Method Details

activate

public void activate(org.osgi.service.component.ComponentContext cc)

Description copied from class: AbstractJobProducer

OSGI activate method.

Overrides:

activate in class AbstractJobProducer

Parameters:

cc - OSGI component context

startTranscription

public Job startTranscription(String mpId,
 Track track,
 String... args)
                       throws TranscriptionServiceException

Specified by:

startTranscription in interface TranscriptionService

Throws:

TranscriptionServiceException

startTranscription

public Job startTranscription(String mpId,
 Track track)
                       throws TranscriptionServiceException

Specified by:

startTranscription in interface TranscriptionService

Throws:

TranscriptionServiceException

transcriptionDone

public void transcriptionDone(String mpId,
 Object obj)
                       throws TranscriptionServiceException

Specified by:

transcriptionDone in interface TranscriptionService

Throws:

TranscriptionServiceException

getLanguage

public String getLanguage()

Specified by:

getLanguage in interface TranscriptionService

getReturnValues

public Map<String,Object> getReturnValues(String mpId,
 String jobId)
                                   throws TranscriptionServiceException

Specified by:

getReturnValues in interface TranscriptionService

Throws:

TranscriptionServiceException

transcriptionError

public void transcriptionError(String mpId,
 Object obj)
                        throws TranscriptionServiceException

Specified by:

transcriptionError in interface TranscriptionService

Throws:

TranscriptionServiceException

process

protected String process(Job job)
                  throws Exception

Description copied from class: AbstractJobProducer

Asks the overriding class to process the arguments using the given operation. The result will be added to the associated job as the payload.

Specified by:

process in class AbstractJobProducer

Parameters:

job - the job to process

Returns:

the operation result

Throws:

Exception

getTranscriptionResults

public String getTranscriptionResults(String jobId)
                               throws TranscriptionServiceException,
IOException

Get transcription result: GET /v1/operations/{name} Method mainly used by the REST endpoint

Parameters:

jobId -

Returns:

job details

Throws:

TranscriptionServiceException

IOException

getGeneratedTranscription

public MediaPackageElement getGeneratedTranscription(String mpId,
 String jobId,
 MediaPackageElement.Type type)
                                              throws TranscriptionServiceException

Specified by:

getGeneratedTranscription in interface TranscriptionService

Throws:

TranscriptionServiceException

getTranscriptionStatus

public String getTranscriptionStatus(String mpId)
                              throws TranscriptionServiceException

Get mediapackage transcription status

Parameters:

mpId - , mediapackage id

Returns:

transcription status

Throws:

TranscriptionServiceException

makeHttpClient

protected org.apache.http.impl.client.CloseableHttpClient makeHttpClient()
                                                                  throws IOException

Throws:

IOException

refreshAccessToken

protected String refreshAccessToken(String clientId,
 String clientSecret,
 String refreshToken)
                             throws TranscriptionServiceException,
IOException

Throws:

TranscriptionServiceException

IOException

getRefreshAccessToken

protected String getRefreshAccessToken()
                                throws TranscriptionServiceException,
IOException

Throws:

TranscriptionServiceException

IOException

uploadAudioFileToGoogleStorage

protected String uploadAudioFileToGoogleStorage(String mpId,
 Track track)
                                         throws TranscriptionServiceException,
IOException

Throws:

TranscriptionServiceException

IOException

deleteStorageFile

protected void deleteStorageFile(String mpId,
 String token)
                          throws IOException

Throws:

IOException

setServiceRegistry

public void setServiceRegistry(ServiceRegistry serviceRegistry)

setSecurityService

public void setSecurityService(SecurityService securityService)

setUserDirectoryService

public void setUserDirectoryService(UserDirectoryService userDirectoryService)

setOrganizationDirectoryService

public void setOrganizationDirectoryService(OrganizationDirectoryService organizationDirectoryService)

setSmtpService

public void setSmtpService(SmtpService service)

setWorkspace

public void setWorkspace(Workspace ws)

setWorkingFileRepository

public void setWorkingFileRepository(WorkingFileRepository wfr)

setDatabase

public void setDatabase(TranscriptionDatabase service)

setAssetManager

public void setAssetManager(AssetManager service)

setWorkflowService

public void setWorkflowService(WorkflowService service)

getServiceRegistry

protected ServiceRegistry getServiceRegistry()

Description copied from class: AbstractJobProducer

Returns a reference to the service registry.

Specified by:

getServiceRegistry in class AbstractJobProducer

Returns:

the service registry

getSecurityService

protected SecurityService getSecurityService()

Description copied from class: AbstractJobProducer

Returns a reference to the security service

Specified by:

getSecurityService in class AbstractJobProducer

Returns:

the security service

getUserDirectoryService

protected UserDirectoryService getUserDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the user directory service

Specified by:

getUserDirectoryService in class AbstractJobProducer

Returns:

the user directory service

getOrganizationDirectoryService

protected OrganizationDirectoryService getOrganizationDirectoryService()

Description copied from class: AbstractJobProducer

Returns a reference to the organization directory service.

Specified by:

getOrganizationDirectoryService in class AbstractJobProducer

Returns:

the organization directory service