AudioObject

trompace.mutations.audioobject.mutation_create_audioobject(*, title: str, contributor: str, creator: str, source: str, format_: str, name: str = None, description: str = None, date: str = None, encodingformat: str = None, embedurl: str = None, url: str = None, contenturl: str = None, language: str = None, inlanguage: str = None, license: str = None, subject: str = None)

Returns a mutation for creating a AudioObject.

Parameters

  • name – The name of the audio object.

  • description – An account of the audio object.

  • date – The date associated with the audio object.

  • creator – The person, organization or service who created the thing the web resource is about.

  • contributor – A person, an organization, or a service responsible for contributing the audio object to the web resource. This can be either a name or a base URL.

  • format_ – A MimeType of the format of the page describing the audio object.

  • encodingformat – A MimeType of the format of object encoded by the audio object.

  • source – The URL of the web resource about this audio object. If no such resource is available, use the same value as contentUrl.

  • subject – The subject of the audio object.

  • contenturl – The URL of the content encoded by the audio object.

  • url –

  • license –

  • language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr

  • inlanguage – The language of the audio object.

  • title – The title of the resource indicated by source

Returns

The string for the mutation for creating the AudioObject.

Raises

  • UnsupportedLanguageException if the input language is not one of the supported languages. –

  • ValueError if a required argument is None –

trompace.mutations.audioobject.mutation_delete_audioobject(identifier: str)

Returns a mutation for deleting a AudioObject based on the identifier.

Parameters

identifier – The unique identifier of the AudioObject.

Returns

The string for the mutation for deleting the AudioObject based on the identifier.

trompace.mutations.audioobject.mutation_merge_audioobject_encoding(audioobject_identifier: str, audiobject_derivative_identifier: str)

Returns a mutation for indicating that a derivative AudioObject encodes a primary AudioObject (https://schema.org/encoding). For example a transcription of a score is an encoding of that score.

Parameters

  • audiobject_identifier – The unique identifier of the “main” AudioObject.

  • audiobject_derivative_identifier – The unique identifier of the AudioObject which is the encoding.

Returns

A GraphQL mutation for MergeAudioObjectEncoding.

trompace.mutations.audioobject.mutation_merge_audioobject_exampleofwork(audioobject_identifier: str, work_identifier: str)

Returns a mutation for indicating that a AudioObject is an example of a work (https://schema.org/exampleOfWork).

Parameters

  • audioobject_identifier – The unique identifier of the AudioObject.

  • work_identifier – The unique identifier of the work that the AudioObject is an example of.

Returns

A GraphQL mutation for MergeAudioObjectExampleOfWork.

trompace.mutations.audioobject.mutation_remove_audioobject_encoding(audioobject_identifier: str, audiobject_derivative_identifier: str)

Returns a mutation for removing that a derivative AudioObject encodes a primary AudioObject (https://schema.org/encoding). For example a transcription of a score is an encoding of that score.

Parameters

  • audiobject_identifier – The unique identifier of the “main” AudioObject.

  • audiobject_derivative_identifier – The unique identifier of the AudioObject which is the encoding.

Returns

A GraphQL mutation for RemoveAudioObjectEncoding.

trompace.mutations.audioobject.mutation_remove_audioobject_exampleofwork(audioobject_identifier: str, work_identifier: str)

Returns a mutation for removing that a AudioObject is an example of a work (https://schema.org/exampleOfWork).

Parameters

  • audio_object_identifier – The unique identifier of the AudioObject.

  • work_identifier – The unique identifier of the work that the AudioObject is an example of.

Returns

A GraphQL mutation for RemoveAudioObjectExampleOfWork.

trompace.mutations.audioobject.mutation_update_audioobject(identifier: str, *, name: str = None, title: str = None, description: str = None, date: str = None, creator: str = None, contributor: str = None, format_: str = None, encodingformat: str = None, source: str = None, license: str = None, subject: str = None, contenturl: str = None, language: str = None, inlanguage: str = None)

Returns a mutation for updating a AudioObject.

Parameters

  • identifier – The identifier of the AudioObject in the CE to be updated.

  • name – The name of the audio object.

  • description – An account of the audio object.

  • date – The date associated with the audio object.

  • creator – The person, organization or service who created the thing the web resource is about.

  • contributor – A person, an organization, or a service responsible for contributing the audio object to the web resource. This can be either a name or a base URL.

  • format_ – A MimeType of the format of the page describing the audio object.

  • encodingformat – A MimeType of the format of object encoded by the audio object.

  • source – The URL of the web resource about this audio object. If no such resource is available, use the same value as contentUrl.

  • subject – The subject of the audio object.

  • contenturl – The URL of the content encoded by the audio object.

  • url –

  • license –

  • language – The language the metadata is written in. Currently supported languages are en,es,ca,nl,de,fr

  • inlanguage – The language of the audio object.

  • title – The title of the resource indicated by source

Returns

The string for the mutation for updating the AudioObject.

Raises

Assertion error if the input language or inlanguage is not one of the supported languages. –