Skip to contents

Communication with LaBB-CAT

URLs/credentials etc. for connecting to your LaBB-CAT server

labbcatCredentials()
Sets the username and password for a given LaBB-CAT server
labbcatTimeout()
Sets the timeout for request to the LaBB-CAT server in future function calls. The default timeout is 10 seconds
labbcatVersionInfo()
Gets version information of all components of LaBB-CAT
getId()
Gets the store's ID
getUserInfo()
Gets information about the current user

Searching and extracting data

Searching for patterns, and extracting information about the resulting matches

getMatches()
Search for tokens
getMatchLabels()
Gets labels of annotations on a given layer, identified by given match IDs
getMatchAlignments()
Gets temporal alignments of matches on a given layer
getSoundFragments()
Gets sound fragments from 'LaBB-CAT'
getFragments()
Gets transcript fragments in a given format
getFragmentAnnotations()
Gets annotations in fragments.
getAllUtterances()
Get all utterances of participants
getMatchingAnnotations()
Gets a list of annotations that match a particular pattern
countMatchingAnnotations()
Gets the number of annotations matching a particular pattern
expressionFromAttributeValue()
Generates a query expression for matching a single-value transcript/participant attribute, for use with getMatches
expressionFromAttributeValues()
Generates a query expression for matching a multi-value transcript/participant attribute, for use with getMatches
expressionFromAttributeValuesCount()
Generates a query expression for matching a transcript/participant attribute, for use with getMatches
expressionFromIds()
Generates a query expression for matching transcripts or participants by ID, for use with getMatches
expressionFromTranscriptTypes()
Generates a transcript query expression for matching transcripts by type, for use with getMatches or getMatchingTranscriptIds

Extracting non-textual annotation data

Accessing images and other files corresponding to annotations on layers with a MIME type

getFragmentAnnotationData()
Gets binary annotation data in fragments.
getMatchingAnnotationData()
Gets binary data for annotations that match a particular pattern.

Processing with Praat

Server-side processing of tokens with Praat

processWithPraat()
Process a set of intervals with Praat
praatScriptCentreOfGravity()
Generates a script for extracting the CoG, for use with processWithPraat
praatScriptFastTrack()
Generates a script for extracting formants using FastTrack, for use with processWithPraat
praatScriptFormants()
Generates a script for extracting formants, for use with processWithPraat
praatScriptIntensity()
Generates a script for extracting maximum intensity, for use with processWithPraat
praatScriptPitch()
Generates a script for extracting pitch, for use with processWithPraat

Transcript information

Identifying transcript IDs, annotations, media, and meta data

getTranscriptAttributes()
Gets transcript attribute values for given transcript IDs
getTranscriptIds()
Gets a list of transcript IDs
getTranscriptIdsInCorpus()
Gets a list of transcript in a corpus
getTranscriptIdsWithParticipant()
Gets a list of IDs of transcripts that include the given participant
formatTranscript()
Gets transcript(s) in a given format
getMatchingTranscriptIds()
Gets a list of IDs of transcripts that match a particular pattern
getMatchingParticipantIds()
Gets a list of IDs of participants that match a particular pattern
getAvailableMedia()
List the media available for the given transcript
getMediaUrl()
Gets the URL of the given media track for a given transcript
getMedia()
Downloads a given media track for a given transcript
saveMedia()
Uploads the given media for the given transcript
deleteMedia()
Delete a transcript's media file
countAnnotations()
Gets the number of annotations on the given layer of the given transcript
getAnchors()
Gets the given anchors in the given transcript
getAnnotations()
Gets the annotations on the given layer of the given transcript
getGraphIds()
Deprecated synonym for getTranscriptIds.
getGraphIdsInCorpus()
Deprecated synonym for getTranscriptIdsInCorpus.
getGraphIdsWithParticipant()
Deprecated synonym for getTranscriptIdsWithParticipant.
getMatchingGraphIds()
Deprecated synonym for getMatchingTranscriptIds.

Transcript management

Uploading/deleting transcripts

newTranscript()
Upload a new transcript
updateTranscript()
Update an existing transcript
transcriptUpload()
Upload a transcript file and associated media files.
transcriptUploadParameters()
Set the parameters of a transcript already uploaded with transcriptUpload.
transcriptUploadDelete()
Cancel a transcript upload started by a previous call to transcriptUpload().
updateFragment()
Update a transcript fragment
deleteTranscript()
Delete a transcript from the corpus

Generating annotations

Generating annotations on selected layers

generateLayer()
Generates a layer
generateLayerUtterances()
Generates a layer for a given set of utterances

Corpus information

Information about how your LaBB-CAT server is organised and configured

getCorpusIds()
Gets a list of corpus IDs
getMediaTracks()
List the predefined media tracks available for transcripts
getParticipantAttributes()
Gets participant attribute values for given participant IDs
getParticipantIds()
Gets a list of participant IDs
getDeserializerDescriptors()
Lists the descriptors of all registered deserializers
getSerializerDescriptors()
Lists the descriptors of all registered serializers
getSystemAttribute()
Gets the value of the given system attribute
nzilbb.labbcat nzilbb.labbcat-package
Accessing Data Stored in 'LaBB-CAT' Instances

Participant management

Functions for creating, updating, and deleting participant records

getParticipant()
Gets information about a single participant
saveParticipant()
Saves information about a single participant
deleteParticipant()
Deletes a participant record
renameParticipants()
Renames a list of participants

Layer management

Functions for managing annotation layers

getLayerIds()
Gets a list of layer IDs
getLayer()
Gets a layer definition
getLayers()
Gets a list of layer definitions
newLayer()
Creates a new layer
saveLayer()
Saves the details of an existing layer
deleteLayer()
Deletes an existing layer
getAnnotatorDescriptor()
Gets annotator information
annotatorExt()
Retrieve annotator's "ext" resource

Lexicon management

Functions for managing dictionaries for lookups and annotation

getDictionaries()
List the dictionaries available
getDictionaryEntries()
Lookup entries in a dictionary
loadLexicon()
Upload a flat lexicon file for lexical tagging
deleteLexicon()
Delete a previously loaded lexicon
addDictionaryEntry()
Adds an entry to a dictionary
removeDictionaryEntry()
Removes an entry from a dictionary
addLayerDictionaryEntry()
Adds an entry to a layer dictionary
removeLayerDictionaryEntry()
Removes an entry from a layer dictionary