Sanity Library Reference Docs
    Preparing search index...

    Function defineVideoField

    • Beta

      Define a video field within a document, object, image or file definition fields array.

      This function will narrow the schema type down to video fields and options based on the provided type-string.

      Using defineVideoField is optional, but should provide improved autocompletion in your IDE, when building your schema. Video field-properties like validation and initialValue will also be more specific.

      Note: This video field type is designed to work specifically with the Media Library asset source. Make sure you have the Media Library is enabled in your studio via sanity.config.ts.

      See defineType for similar examples.

      Parameters

      • definition: Omit<VideoDefinition, "type"> & FieldDefinitionBase

        should be a valid video field type definition.

      Returns {
          components?: ObjectComponents;
          deprecated?: DeprecatedProperty;
          description?: string | Element;
          fields?: FieldDefinition<
              | "string"
              | "number"
              | "boolean"
              | "object"
              | "array"
              | "block"
              | "date"
              | "datetime"
              | "document"
              | "file"
              | "geopoint"
              | "image"
              | "reference"
              | "crossDatasetReference"
              | "globalDocumentReference"
              | "slug"
              | "text"
              | "url"
              | "email"
              | "sanity.video",
              undefined,
          >[];
          fieldset?: string;
          fieldsets?: FieldsetDefinition[];
          group?: string
          | string[];
          hidden?: ConditionalProperty;
          icon?: ComponentType | ReactNode;
          initialValue?: InitialValueProperty<any, VideoValue>;
          name: string;
          options?: VideoOptions;
          preview?: PreviewConfig;
          readOnly?: ConditionalProperty;
          renderMembers?: ObjectRenderMembersCallback;
          title?: string;
          type: "sanity.video";
          validation?: ValidationBuilder<VideoRule, VideoValue>;
      } & WidenValidation & WidenInitialValue

      • Optional Betacomponents?: ObjectComponents
      • Optionaldeprecated?: DeprecatedProperty
      • Optionaldescription?: string | Element
      • Optionalfields?: FieldDefinition<
            | "string"
            | "number"
            | "boolean"
            | "object"
            | "array"
            | "block"
            | "date"
            | "datetime"
            | "document"
            | "file"
            | "geopoint"
            | "image"
            | "reference"
            | "crossDatasetReference"
            | "globalDocumentReference"
            | "slug"
            | "text"
            | "url"
            | "email"
            | "sanity.video",
            undefined,
        >[]
      • Optionalfieldset?: string
      • Optionalfieldsets?: FieldsetDefinition[]
      • Optionalgroup?: string | string[]
      • Optionalhidden?: ConditionalProperty
      • Optionalicon?: ComponentType | ReactNode
      • OptionalinitialValue?: InitialValueProperty<any, VideoValue>
      • name: string
      • Optionaloptions?: VideoOptions
      • Optionalpreview?: PreviewConfig
      • OptionalreadOnly?: ConditionalProperty
      • Optional BetarenderMembers?: ObjectRenderMembersCallback

        Callback that allows developers to customize the members of the object input. It can be used to add decoration members to the object input, instead of using empty fields. For example:

        import { Decoration } from './Decoration'

        renderMembers: (members) => {
          return [
            ...members,
            {
              key: 'decoration',
              kind: 'decoration',
              component: Decoration,
            },
          ]
      • Optionaltitle?: string
      • type: "sanity.video"
      • Optionalvalidation?: ValidationBuilder<VideoRule, VideoValue>
      • defineField
      • defineArrayMember
      • typed

    Settings

    Member Visibility