Skip to content

Commit

Permalink
Added API comments
Browse files Browse the repository at this point in the history
  • Loading branch information
dukesook committed Nov 4, 2023
1 parent 1859ffd commit e8c158c
Showing 1 changed file with 7 additions and 1 deletion.
8 changes: 7 additions & 1 deletion libheif/heif_properties.h
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,11 @@ void heif_item_get_property_transform_crop_borders(const struct heif_context* co

// ========================= Timestamps =========================
// Creates a clock info property if it doesn't already exist.
// null arguments are ignored. (expect for ctx)
// A null clock argument implies that the value is unknown.
// Example:
// int64_t offset = 0x100;
// heif_property_id propertyId;
// heif_property_set_clock_info(ctx, itemId, nullptr, &offset, nullptr, nullptr, &propertyId);
LIBHEIF_API
struct heif_error heif_property_set_clock_info(const struct heif_context* ctx,
heif_item_id itemId,
Expand All @@ -146,6 +150,8 @@ struct heif_error heif_property_set_clock_info(const struct heif_context* ctx,
const uint8_t* clock_source,
heif_property_id* out_propertyId);

// If the value is unknown, the pointer is set to nullptr.
// A null clock argument implies that the value is unknown.
LIBHEIF_API
struct heif_error heif_property_get_clock_info(const struct heif_context* ctx,
heif_item_id itemId,
Expand Down

0 comments on commit e8c158c

Please sign in to comment.