Class FunctionConfig
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<FunctionConfig.Builder,FunctionConfig>
The output configuration settings for a function. Use this structure to run a function on this feed. The name of the output is the name that you pass to GetMetadata to read the results.
Include the settings that the function's media context and trigger require. Elemental Inference ignores settings that neither uses. It also rejects settings whose frames are estimated to exceed the size of a single model request.
A feed that has an enabled function output must also have an enabled cropping, clipping, subtitling, or contextual metadata output. A feed that runs a function with a Bedrock target must specify an accessRoleArn.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionstatic FunctionConfig.Builderbuilder()final ClippingSettingsThe event clipping output on this feed to read clips from.The contextual metadata output on this feed to read scenes and classifications from.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final FrameSettingsThe frames to send on each run: how many, which ones, and at what size.final StringThe ARN of the function to run.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()static Class<? extends FunctionConfig.Builder> final SubtitlingSettingsThe smart subtitles output on this feed to read the transcript from.Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.final Triggertrigger()Determines when the function runs.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
functionArn
The ARN of the function to run. The function must exist in the same account and the same Region as the feed.
- Returns:
- The ARN of the function to run. The function must exist in the same account and the same Region as the feed.
-
trigger
Determines when the function runs.
- Returns:
- Determines when the function runs.
-
frameSettings
The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.
- Returns:
- The frames to send on each run: how many, which ones, and at what size. Applies to a function that references media.frames. If you omit this structure, Elemental Inference sends the first frame of the window, at its source size.
-
subtitlingSettings
The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.
- Returns:
- The smart subtitles output on this feed to read the transcript from. Required for a function that references media.transcript.
-
contextualMetadataSettings
The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.
- Returns:
- The contextual metadata output on this feed to read scenes and classifications from. Required for a perScene trigger, and for a function that references media.contextual on a perShot trigger.
-
clippingSettings
The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.
- Returns:
- The event clipping output on this feed to read clips from. Required for a perClip trigger, and for a function that references media.clip.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<FunctionConfig.Builder,FunctionConfig> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-